此页面正在维护中!
技术背景报告难以定义—它的 不 很多事情,但很难说是什么。 是. 它并不像说明那样提供逐步的操作指导。它也不像可行性报告那样正式提供建议。它并不像原始研究报告那样报告数据并得出结论。
那么技术背景报告是做什么的?它提供技术主题的信息,但以适应特定受众的方式,这些受众对该信息有特定的需求。想象一个这样的主题:肾脏疾病和治疗。关于这个主题的技术背景报告将会 不 倾倒出一本十吨重的教科书,包含关于它的所有可能信息。它将选择与特定读者群体的特定需求和用途相关的信息。想象一下,受众是一群正在竞标为透析诊所部分工作而工作的工程师。是的,他们需要了解肾脏疾病及其治疗,但仅限于与他们的专业领域相关的内容。这份背景报告还可能包括一些关于肾脏疾病及其治疗的基本讨论,但不超过工程师完成工作和与诊所代表互动所需的信息。
看一下这些例子 技术背景报告.
其中一份报告探讨了全球变暖,或称为温室效应。请注意,它讨论了原因,然后探讨了影响,最后讨论了可以采取的措施。
技术背景报告的内容和组织结构
与本课程指南中讨论的大多数其他报告不同,技术背景报告没有一个共同的内容集。因为它专注于特定的技术主题,针对有特定需求或用途的信息的特定受众,所以它会抓取完成工作所需的任何内容。你需要大量依靠直觉来规划这种类型的报告。例如,在关于肾脏疾病和治疗的报告中,你可能想讨论肾脏疾病是什么、它的成因、如何治疗以及治疗中涉及了哪些技术。如果你不完全信任你的直觉,可以使用以下清单:
- 定义—定义与该主题相关的潜在不熟悉的术语。写 扩展的 定义,如果有关键术语或如果它们特别难以解释。
- 原因—解释与该主题相关的原因。例如,对于肾脏疾病主题,是什么导致了这种疾病?
- 影响—解释与该主题相关的后果、结果或影响。关于肾脏疾病这个主题,患有该疾病的人会发生什么;各种治疗的效果如何?
- 类型—讨论与该主题相关的不同类型或类别。例如,肾病是否有不同类型;治疗是否有不同类别?
- 历史背景—讨论与该主题相关的历史。讨论与该主题相关的人物、事件和过去的理论。
- 流程—讨论与该主题相关的机械、自然和人控过程。逐步解释该过程如何发生。例如,肾病循环的阶段是什么;患有特定形式疾病的人通常会发生什么?
- 描述—提供与该主题相关物品的物理细节信息。提供关于大小、形状、颜色、重量等方面的信息。对于面向工程的技术文件,这将意味着关于处理技术的大小、功率要求以及其他此类细节的信息。
- 比较—将该主题或其某个方面与某个相似的事物或熟悉的事物进行比较。以肾脏疾病为例,您可以将肾脏疾病与其他疾病进行比较;将治疗与某种治疗进行比较;将肾脏的功能与某个熟悉的事物进行比较(类比);或者甚至将治疗与某个熟悉的事物进行比较,例如游泳池的过滤系统。
- 应用程序—探索您主题的某个方面如何被使用或应用。如果它是某种新技术,它的应用有哪些?
- 优点和缺点—讨论你主题一个或多个方面的优缺点。在肾脏疾病这个主题中,例如,一种治疗相对于另一种治疗有哪些优点?
- 经济考虑—讨论与您的主题相关的一个或多个方面的费用。肾病治疗的费用是多少?设备和人员的费用是多少?
- 社会、政治、法律、伦理影响—探讨你的主题或其某个方面在社会、政治、法律或伦理问题上的影响或冲击。肾脏疾病的例子在这一领域并不太适用,但想象一下像冷冻技术—人类的悬浮动画这样的主题所带来的可能性。通常,新技术在这些领域会产生深远的影响。
- 问题,疑问—与您的技术文档主题或其某个方面有关的问题或疑问有哪些?
- 解决方案,答案—您能针对您话题或其某个方面提出的问题或问题提供哪些解决方案或答案?
我们可以在这样的清单中添加许多其他类别,但也许这些已经足够让你开始规划技术背景报告的内容。请记住,这些清单项目中的每一项可能代表报告中的一个完整部分,而不是一句话或两句话。
关于报告各部分的组织,你的直觉是正确的。某些子主题在逻辑上应当放在其他子主题之前。参见章节中的 组织模式 并加以应用。
技术背景报告的格式
该章节带你从封面一直到该类报告的最后一页,展示了预期的内容和格式。请记住,在大多数技术写作课程中,你应当准确无误地使用这样的格式—除非你与导师达成其他安排。
相关信息
阅读测验. 使用这个测验来测试你对本章的理解。
我很感激你对这一章的想法、反应和批评: 你的回复—大卫·麦克默里.
