技术报告结构 - 技术报告的示例格式
技术报告结构
商业和工业的技术报告结构应包括以下几部分:
- 转送函
- 封面
- 摘要
- 表的内容
- 的插图
- 执行摘要
- 术语表和符号列表
- 介绍
- 身体
- 结论
- 建议
- 附录
还看到:目的和使用技术报告
1.信
报告的组件不是用它们出现的相同顺序写入。传输字母是读者看到的第一件事，但它可能是最后一个要创造的。它介绍了报告的目的和内容到原则读者。它让您有机会强调无论您认为什么，您的读者都会在附带的材料中找到。它使您能够指出材料中的任何错误或遗漏。传输字母包含以下元素。
- 报告的标题和目的的陈述。
- 谁授权该项目的陈述
- 项目中使用的方法或主要结果、结论和建议的说明。
- 确认您在准备材料时收到的任何帮助。
2.标题页
技术报告中标题页的常用元素是：
- 标题
- 作者姓名、职务
- 主要阅读者的姓名和职务
- 提交日期
一个好的标题必须包含丰富的信息。它。回答两个基本问题:
- 报告的主题是什么
- 这是什么类型的报告?例如海洋污染控制装置
Define the type of report by using a generic term such as analysis, recommendations e.g summary, review etc. For a simple title page, centre the title (typed in full capital letter) about a third of the way down the page, then add the readers and writer's position, the organization’s name and date.
3.的摘要
在技术报告结构中，摘要就像一个简短的技术摘要，通常不超过200字的报告。它针对熟悉技术主题的读者，需要知道是否阅读完整报告。这可以使用技术术语并参考高级概念。摘要的基本类型是描述性和信息性的摘要。描述性抽象有时称为局部或目录摘要。它没有提供进口结果，结论或建议。它列出了所涵盖的主题给每个主题给出每个覆盖范围。信息摘要规定了问题范围和方法的问题，以及主要结果，结论或建议。
4.目录
技术报告结构中的内容表使不同的读者能够转向特定页面以查找所需的信息。如果内容表，则组织良好的报告是无效的。T.O.c提供报告结构，覆盖范围和分感的指南。报告中出现的标题在t.o.c.中列出有效T.O.c确保报告有效标题。
5.插图清单
这是技术报告中的数字和表格的T.O.C。如果报告包含数字而不是表格，则称为数字列表。但如果报告中包含表格而不是数字，则只称为表格列表。插图可以在同一页的目录，也可以在单独的一页。如果它在另一页开始，它应该在目录中列出。
6.执行总结
有时称为执行概述或技术报告结构中的管理摘要。这是一个报告的一个页面凝结。由于时间和专业化的限制，管理人员不需要对其组织中进行的各种项目进行详细和深刻的理解。该项目的背景也在此处清楚地讨论。清楚地讨论了通过项目解决的具体问题;此外，结论和建议是在一个完整的单独段落中进行了讨论的。
7.术语表和符号列表
词汇表是一个字母清单的定义列表。如果您正在解决包含不熟悉报告中使用的技术词汇的读者，则非常有用。可以沿着单词使用星号或任何其他符号，以告诉观众在词汇表中定义这个词。它通常在附录之前的报告结束时。虽然如果术语表是一个简短的话，所以可以在目录之后放置。符号列表是结构化的，但不是定义单词和短语，而不是定义报表中使用的符号和缩写。与词汇表一样，可以在附录或内容表之后放置符号列表。
介绍
你将在报告主体中呈现的材料必须根据项目/报告的类型来设置。本节向读者提供必要的背景信息，并直接进入报告本身。一个典型的介绍可以包括以下内容:
- 报告的主要目标，目标和范围（参数）
- 确定当前项目的科学知识或商业运营的重要性
- 报告部分的概述
- 方法(s)的方法
- 研究范围和局限性的指征
- 报告剩下的材料概要。
9.身体
这将包括报告的所有主要内容，如任务是什么，这些发现是什么，方法论是如何找到结果，比较和对结果的比较和讨论。这通常是报告结构中最长，最重要的部分，因此必须逻辑地呈现材料以使其易于阅读。它分为编号和头部部分。这些部分以逻辑顺序分别不同的主要思想。
10.结论
它回答了原始研究问题或研究目标提出的问题。结论应该是干预部分的浓缩版，这给了工作的主要结果。这里没有展示新的科学论点 - 一切都应该在“讨论”中讨论。
- 参阅报告的原目的及目的，
- 研究结果的局限性和优势，
- 对证据的客观意见、评价或判断
结论必须从报告正文中讨论的证据中得出。因此，它不应该主观地告诉读者该做什么，这项工作是由推荐部分完成的。
11.建议
在一些报告中，还需要结论。应从报告的结论中出现这些建议。建议告诉读者该做什么：做出什么决定，采取什么行动，解决方案优越或需要进一步的工作。建议部分不应包含任何新证据，并应从机构和结论部分中提出的信息出现。
技术报告结构中的建议应是可行的和适合问题的;例如，他们的成本应该符合预算，他们应该符合道德标准。它们应该尽可能具体和具体;他们应该阅读客户应该做的事情的清单。它们可以是描述性的，也可以是项目符号的形式。通过提供你从报告结论中得出的决定的原因，让你的读者知道你为什么建议采取行动。
12.附录
在技术报告结构中，附录是报告正文之后的任何部分(以及参考书目、术语表或符号列表)。附录提供的信息过于庞大，无法在正文中呈现，或者只有少数读者感兴趣。为了报告的简洁性，这些信息与正文是分开的。通常在附录中发现的材料的例子包括地图、大型技术图表或图表、计算、测试数据和支持文件的文本。附录通常是字母，而不是编号，并列在目录中。
