如何写一份技术报告

总结

1.指南的需要

• • 1.1.目标

• 1.2.使用这个报告

2.通信

• • 2.1.渠道和信息

• • 2.2.作者

• 2.3.读者

3.整个文件的结构

• • 3.1.标题

• • 3.2.的内容

• • 3.3.摘要

• 3.4.结论

4.报告正文

• 4.1.材料的内容
• 4.2.起草框架
  • • 4.2.1.内容的依赖
  • • 4.2.2.地标性建筑
  • • 4.2.3.平行的概念
  • 4.2.4.编号

5.写作

• • 5.1.良好的英语

• • 5.2.选择

• • 5.3.风格

• • 5.4.修正

• • 5.5.附录

• • 5.6.图

• 5.7.一些不该做的事

6.行动计划的作者

附录1——调查问卷

附录2-我对上述问卷的回应

总结

1.虽然与消防安全报告的撰写没有直接关系，但对于消防安全主任和顾问来说，撰写报告是一项非常重要和必要的技能。重要的是要以简洁和准确的形式告知客户对他们的要求以及他们需要执行的任何行动。本页还以报告的形式书写，以加强本文的观点。

2.没有经验的作者需要指导方针来帮助他编写早期的技术报告。本文档提供了这样的指导，并帮助他应用这些指导。

3.首先考察在作者和读者之间传递信息的信息通道。这就说明了为什么作者既要清楚自己的目的，又要了解读者的观点是很重要的。

4.一份技术报告服务于两类读者，一类是希望快速掌握要点的读者，另一类是希望在按照其建议采取行动之前，对其所有的推理和结论进行批判的读者。它建议标题、内容页、摘要和结论应该能够独立地满足第一类，通常更重要的读者。

5.对于第二种，更忠实的读者，本文探讨了一份报告的材料应该如何组装，然后挂在一个起草框架上。这确保了内容的逻辑呈现。它向读者展示了如何通过了解该框架来帮助读者。

6.第五节讨论与撰写报告主体有关的各种主题。这些都强调了为读者着想的必要性。只有这样，他们才能获得清晰、有趣和真实的信息。

7.最后提供了一项行动方案，其中介绍了新作者编写其第一份技术报告的任务。

1.指引的需要

1.1.目标

消防安全主任、顾问及参与消防安全事宜的人士，有时会被要求撰写报告。与客户沟通并提供准确有效的指示或信息是必要的。因此，本报告的目的如下:

为你的报告写作提供指导，以确保你的报告写作更有效。

它还被写出来，以便在写作开始前快速阅读，从而让作者掌握如何开始这项任务。

1.2.使用这个报告

每个写报告的人都面临一个实际问题，那就是太笼统了。为了避免这种情况，必须不时介绍说明性的例子。因此，我利用的事实是，这份文件本身就是一份报告，它应该能够说明它所宣扬的原则。有时，读者会被邀请回到以前的一些文章，在那里他会发现一个原则的观点是由他在不同的语境中已经读过的词语所阐明的。

第六部分提供了行动清单，在那里我在我的写作和你的写作之间进行过渡。

2.沟通

2.1渠道与信息

写报告是沟通过程的一部分。如图1所示，主要部分是一端的作者和另一端的读者。报告本身是沿着它们之间的通道流动的消息。

图1书面报告被视为
一个通信信道

因此，写报告是一个正确瞄准信息的问题，而阅读报告是一个接受信息并正确解释其含义的问题。有这么多的书面工作影响着人们，接受一份报告就像打开一个过滤器，有选择地允许信息通过。因此，报告写作的第一步必须同时考虑作者和读者。

2.2作者

这里有一个问题列表，你，潜在的作者，在你动笔之前必须回答。此外，在写报告的时候，答案必须一直记在心里。

a.你希望你的报告触发什么动作?
b.谁将是读者?
c.他们有多少人?
d.他们对该学科的知识水平如何?

明确地回答这些问题是非常重要的。的确，把答案写下来是值得的。附录为此目的提供了一份调查问卷。它也展示了我在准备这份报告时是如何回答问题的。

当这些问题得到回答后，就会对任务有一个更实际的看法。你会意识到哪种写作风格是最合适的，你要捕捉多少别人的时间，以及打印和复制工作所涉及的规模。最重要的是，读者的身份是确定的，你自己的动机是明确的。

但是，仅仅考虑你的动机和从外部角度看读者是不够的，你还必须试着站在读者的角度考虑，想象他们收到你的报告时会是什么样子。

2.3读者

阅读既费力又耗时，所以第一个问题就是，我为什么要读这本书?

别忘了你不会在那里回答他;在这个阶段，摆在他面前的只有封面上的标题。这个问题只能笼统地回答。因此，他只会希望打开封面，并继续读下去，如果他被引导相信，他将获得对他所关心的主题的见解，他将受益于未来。

这使得标题非常重要。“我为什么要读这个?”在考虑撰写报告时，这是一个关键问题，因为它不仅适用于标题，而且始终存在于读者的脑海中。这是构建整个报告必须使用的标准。它还可以提醒读者，在阅读报告的主体部分时，不要因遇到困难而使读者感到厌烦或负担。最后，它还可以警告你，不要因为糟糕的写作而使你的信息被误解或拒绝。这三个方面的报告写作提供了本报告的下一节。它们不是连续出现的，而应该被认为是平行的主题，然后在第六节中组合在一起。

3.The整个文件的结构

3.1标题

我已经说明了标题的重要性。显然，没有必要一开始就把确切的单词写下来。实际上，最好是等到报告接近完成时再最终修改它。尽管如此，它还是值得在开始的时候在脑海中有一个标题，并在报告发展的过程中记下修改和改进。随着工作的进展，这份报告的标题发生了一些变化。他们是:-

如何写一份技术报告
我为什么要读这个?
为什么要读吗?

当我重读第二和第三部分时，“如何写一份技术报告”这个词似乎是最好的，因为它陈述了一种说法，而没有提出任何问题。如果你的标题说服读者打开封面，他会寻找什么?有两件事，

内容页面
一个总结

这两个项目现在应该很容易访问。每个都在下面讨论。

3.2目录界面

在这个阶段，你的读者不会完全读完你的报告，只有当你能很快地让他放心，他的时间是被合理利用的时候，他才会打开他的过滤器。

内容页可以做到这一点。它当然将由报告所有部分的副标题组成。当这些字幕第一次写出来的时候，它们被记录下来，以便识别后面章节的内容。这是目录页所需要的，但当你写报告时，可能需要重新遣词造句，以使目录页本身成为有意义的文档。

此外，内容页可以通过报告的设置方式来传达报告的结构。看看这份报告的目录页。从中你会发现你的阅读达到了什么程度。幸运的是，在报告中，内容页的第二个作用与帮助读者决定是否继续阅读的首要作用没有任何冲突。(这在大型书籍中不是这样的，因为冗长的内容列表有时会被用作索引)。

3.3总结

假设您的读者已经从目录页中发现，他可以从阅读更多的内容中受益，但他仍然没有完全致力于阅读完整的文档。

他需要的是一个总结，所以提供一个。尽量只写一页。这样，他一眼就能看出他要做的阅读任务有多大。还要确保报告的结构清晰，段落清晰，最好是用项目要点的子集，例如概述报告的结论。

你应该在主报告写好之后再写摘要。实际上，在写总结之前，你应该用一个完整的环节通读你的报告。

你可以给自己计时。如果你预计有50个读者，每个人都要花一个小时，那么你至少可以问问自己的良心，你是否像重视自己的时间一样重视别人的时间。因为正如我稍后将强调的，好的报告写作非常关注为他人着想。

3.4的结论

如果你的读者发现内容和摘要与他的需要相关，那么他可能准备好阅读主要文件。在后面的章节中，我们将讨论他对你的要求。

然而，也会有人认为阅读内容和摘要就差不多了。这样的读者通常是最高级的，负有最广泛的责任，可以触发您的报告想要实现的行动。他们还想从你的报告中再得到一个项目，这个项目可以回答他们额外的问题“那么我应该怎么做?”因此，他们将在报告中寻找另一个章节。题为“结论”或“建议”，或可能为“要采取的行动”。

你可以看到，本报告的结论已记录在“作者行动方案”的副标题下。

现在你有了两种类型的读者，一种是继续阅读，另一种是在阅读了“结论”部分后关闭报告。

后者的需要应该得到尊重。这意味着你应该写的标题，内容，总结和结论可以独立作为一个不言自明的文件。

因此，在这个非常特殊的意义上，你要写两份报告:“标题、内容、总结和结论”报告
还有整个报告。但是，在编写完报告的主体之前，不能启动前者。

您可能会发现现在关闭该报告并重新打开它以确定您属于哪一组读者是很有帮助的。

如果这样做的结果是你又回到了这一点，那么你就会想知道如何开始自己的写作。接下来的两节涉及两个方面:塑造报告和使其具有实质内容。

4.报告正文

4.1材料内容

没有人能写出好的报告，除非他们有一个深思熟虑的想法，有一些数据和结果来交流和解释。

因此，非常有用的第一步是写下你想要表达的所有观点。这个单词和短语列表可以作为想法的仓库，在需要的时候加以利用。把任何相关的想法立即记录下来，并储存起来。在这个阶段，列表没有逻辑顺序并不重要。

例如，这份报告是由一捆笔记、一本有一些段落标记的书和一份关于主题的三页打字笔记发展而来的。

4.2起草框架

4.2.1内容准备依赖

现在需要将报告的潜在材料挂到逻辑框架上。此外，为了读者的利益，框架的形状需要是不言自明的。

主题在定义什么是合适的框架方面起着重要作用。例如，描述某人应该如何使用新设计的设备的技术报告可能需要如图2所示的框架。这表明，主题可能必须被分解成平行的主题，尽管物理上它将需要一个系列的展示。

图2可能用于报告如何使用新设备的框架

这里要强调的是，起草框架的设置没有绝对的对错之分。可能会有两三个同样可以接受的替代方案。重要的是你的读者很快就会意识到你选的是哪一个。这意味着你必须告诉他。内容列表是一个有用的指南，当然，当翻页时，它应该反映在报告的布局、标题和插图中。

4.2.2地标

你可能需要提供比这些标题更多的指导，这样你的读者总是能回答我在这篇报告的哪里?因此，作为一个指南，你应该在你的报告的某些部分结束，指出读者接下来要去哪里，有时他已经去了哪里。当然，这一原则必须慎用，以避免不适当的重复和填充。例如，请注意本报告第2.1、2.2、2.3、3.1和3.4节的结尾句是如何做到这一点的。有时将这些标记放在章节的开头更合适，如3.3和3.4所示。

4.2.3平行的概念

在一种非常常见的情况下，这些地标尤其重要。我称之为“平行概念”问题。简单地说，当一个主题需要解释两个或两个以上不同的观点，然后才能把它们的含义结合在一起，或报告以有意义的方式继续时，就会出现这种情况。

一旦第一个概念被提出，你就必须改变主题来提出下一个。这可能会让读者感到困惑，因为他们本来有理由期待报告继续下去。当这个问题出现时，最明显的解决方法是提前告诉读者会发生什么。图3说明了应该如何引入这些特殊的地标。此外，本报告的一个例子将在2.3节的末尾找到。

在报告中引入里程碑，通知读者该主题需要并行发展。

4.2.4编号

这个报告演示了一个分级编号系统。这种方法的一个优点是，它可以帮助读者理解文档的结构。例如，在本例中，数字4.2.4提醒了“编号”这一节作为本报告主题的重要性和地位。

因此:
4.报告正文
4.1
4.2起草框架
4.2.1
4.2.2
4.2.4编号

然而，编号可能会过度，在某些情况下，应该允许对这种系统进行一些放松。当字母a) b) c)同样能达到目的时，没有读者会喜欢4.2.4.1 - 4.2.4.2等进一步的子集。在5.3和5.4节中有示例。这种编号方式也有助于控制书写页面的格式。对于忙碌的读者来说，没有什么比一页完全是矩形的打字稿更令人不快的了。如果这样的页面仍然出现，即使有一个编号系统检查，以确保你没有在一个部分包含太多的材料或忽略了一些结构的想法，这将有助于读者。

5.写作

5.1良好的英语

在4.1节中，我指出，如果你的报告要吸引读者，你必须有有用的和结构良好的材料。但同样重要的是，要确保读者不会因为无聊或恼怒而关闭报告。此外，他必须正确地理解你的意思。这些重要的附加要求只有通过在写作时清晰地思考和用良好的英语表达这些想法才能得到满足。在这种情况下，良好的英语意味着清晰、有趣和信息量大。当然，这需要大量的词汇量和对英语语法的理解。这里不讨论这些主题。对于需要这类帮助的读者，推荐以下书籍。

A. E. DARBYSHIRE撰写的报告由爱德华·阿诺德有限公司出版。

作者:E.高尔爵士，企鹅图书有限公司出版。

企鹅图书有限公司出版的《罗格斯同义词典》。

ROGETS的同义词典是字典的反面。也就是说，它不是告诉你一个给定的单词是什么意思，而是提供了符合你已经想到的意思的替代单词。例如，下一节中使用的单词“Roundabout”是通过在同义词典中查找“Long-winded”找到的。最后，你还需要字典或拼写检查器，既可以检查你怀疑的拼写，也可以确保你所归属的单词的意思是正确的。

5.2选择

事实的正确性和完整性是科学写作中两个重要的考虑因素，它们必须得到尊重。然而，他们会让你陷入困境。对正确性的尊重不应变成坚持要求注意事项，因为写信人不愿意忽略他已经想到的主题的某些额外方面。我在第3.2节末尾提供了一个示例。括号中的段落没有任何用处，应该删掉。应避免这种感叹词对主语连续性造成的干扰。你的任务是思考它们的相关性，而不是把这种负担强加给读者。

你花了很多时间研究后来被证明是不必要的记录，这可能表明你的勤奋和彻底。然而，在报告中包含对这种经历的冗长描述意味着你没有考虑到读者的需求。

避免这些陷阱的关键已经被热烈讨论过。在2.2节中，我提出了四个问题。你应该总是把这些问题的答案记在心里。(见附录)另一个保障措施是经常参考起草框架。

5.3风格

这方面的报告写作可以深入探讨(参见第5.1节的参考资料)。然而，一般来说，报告写作风格的选择归结为一个标准:为读者考虑。因此，你的写作风格应体现以下几点:

a)他是个大忙人，所以要简短明了。
b)他在寻找事实——所以你要讲得清楚而翔实。
c)他可能对你来说比较陌生——所以要适当正式。

在最后一点上意见不一。有些作家完全避免人称代词，以达到不带人情味的效果。不幸的是，它会导致迂回的措辞。你可以从这份报告中看出，我认为这种风格不适合在这里使用。

通过回应以上的考虑，你的写作将保持有趣。因为兴趣不是来自作者的复杂性和个性的投射，它依赖于在沟通渠道上发送一个清晰的信息。对2.2节问题的回答也指出了适合的风格。(见附录)

5.4修改

一份好的报告通常需要:-

a)初稿(阅读并改进其结构和一致性)。
b)第二稿(增加标题和摘要)。
c)第三稿(征求建设性评论家的第二意见，消除错误并改进格式)。
d)经过精心编辑和修正的最终版本。

5.5附录

附录可以达到两个主要目的。第一个是为你的一些读者提供详细和专门的信息。这些读者通常是你的同龄人。他们可能希望从你留下的地方开始工作，或者他们可能不得不执行你的建议。因此，你的任务是解释你的假设，提供数据，并使它们达到与你自己相同的知识状态。

如果这是附录的目的，那么报告必须有可能没有附录。因此，在主报告中必须有一个自成一体的陈述，使读者能够在不阅读附录的情况下理解你的主题。

第二个目的是提供报告中经常需要的资料来源，否则将不得不重复几次。确保你的读者能够方便快捷地获取信息是很重要的。在特殊情况下，这可能要求你把附录放在扩展页上，或把它松散地放在后面的口袋里。这就是本报告附录的目的，附录以彩色纸印刷，以便你在有需要时查阅。到目前为止，你已经被提到过三次了。

5.6图

科学读者通常会发现表格、图表和图表是可以接受的。他们经常翻页寻找报告的关键思想，只有在检查图表时才停下来。其他读者不会用这种方式搜索信息。他们倾向于非常肤浅地忽略图表。

满足这双重需求的方法是确保文本和相关的图表几乎可以独立存在。因此，关于图表的要点应该在文中说明。同样，图表应该有一个完整的标题，并且在很大程度上是自解释的。这样，两种精神态度都得到了满足。提供的重复信息不过分，这将有助于减少误解的风险。这份报告中的数字只是举例。

5.7一些不该做的事

许多报告以“介绍”一节开始。这个词的意思是“引入的行为”。当你的读者读到第一页的时候，他就要开始读了。但是这个词并没有告诉他这一节的内容。他可能正要读到:

a)历史背景
b)报告的宗旨
c)该项研究的职权范围
d)报告的结构
e)一个不知道如何开始的作者把这些乱七八糟的东西混在一起。

不要写“介绍”一节。用描述第一部分的名称来命名它。(作为例子，请参阅本报告的第1节)。

类似的评论也适用于序言。如果这是一个关于致谢或报告结构的初步部分，那么就说出来。如果有一个明确的情况下序言，那么它应该放在左边的页面，而不是右边的内容列表或摘要。

这些警示性的文字完成了这份报告所要提供的建议。你应该记得，第三节讨论了报告中忙碌的读者可能会选择的部分。第四部分讨论了组织材料的重要性;而第五部分涵盖了一些关于写作的实际要点。

但如果你的报告要存在你就得开始写了。准备好材料，退到一个安静的角落，打开第六部分开始。

6.作者行动计划

6.1你和你的读者

附录中有一张空白表格，请填写。

6.2你的材料

写下你能想到的所有你认为应该写进报告的东西。任何顺序的粗略笔记都可以。如果你以后想到了更多，把它们添加到你的列表中。

6.3你的起草框架

用图表或通过初步的内容列表设计框架，这将指导和结构你的写作。图4提供了一个更广泛的结构，您的框架应该适合在其中。现在你对所有你要写的东西都有了一个概念。

在纸的最上面写上“本报告的目的是回答以下问题”，现在你要靠自己了。

6.5你的风格

一旦你写了几个句子，你应该考虑你使用的写作风格。检查它是否适合你心目中的读者数量和类型。

6.6如果你卡住了

您可能不确定在您的起草框架中定义的某些部分应该写什么。如果出现这种情况，给该部分编号，并将其留空。转到你更清楚自己要写什么的另一个部分。之后你会发现，把遗漏的部分补上就容易多了。

6.7你的结论

假设你现在已经写了报告的大部分内容，在写结论之前回顾一下你的目标。这些目标记录在您在6.1节完成的附录中。

6.8目录页面

系统地阅读你的报告，记录标题，边读边读。请确保编号正确。你对这个结构满意吗?如果是，请完成内容页，并将其作为单独的文档进行审查。如果没有做出必要的改变。

6.9你的总结

在读完你的报告后，准备一页的总结。这是你报告中非常重要的一部分，所以你应该特别注意。每一个单词和短语都应该被仔细检查，以确保你清楚和简要地表达了你的报告的精髓。不要忘记，它也需要一个清晰的结构。

6.10你的图表和打字

打字员不是艺术家，打字机也不是绘图机，所以当你把手稿交给打字时，不要指望你的图表会以最终的形式重新出现。与打字员交谈，清楚地解释你想要什么，并就图表的大小和位置征求她的意见。通常情况下，你必须自己画这些图或求助于专业人士。添加标题。

6.11.修订

现在你有了第二稿，你应该把它给一个建设性的批评家看。如果有人建议你在形式或内容上做很大的改变，不要感到惊讶、生气或气馁。希望这份报告能降低这种情况发生的风险。请放心，这是大多数“第一次”报告的命运，然后重新开始。

6.12最后的润色

最终你和你的批评者都会满意的。此时，您应该用字典检查每一个您怀疑的拼写，以确保所有编号和交叉引用都是正确的，将所有图表放在适当的位置，并将其发送给复制。

附录1

你的目标和你的读者
问卷调查

你报告的标题是什么?..............................................................................................................................

你想让这份报告触发什么行动?......................................................................................................

什么样的人会成为读者?..................................................................................................................

他们有多少人?....................................................................................................................................

他们对这门学科的知识水平如何?.........................................................................................................

附录2

回答以上问卷

你报告的标题是什么?

如何写一份技术报告
我为什么要读这个?
报告写作。

你想让这份报告触发什么行动?

我希望这个网页是为了让这个网站的访问者了解一些因素，这将进入写好报告，并随后使用它作为一套指导方针，以帮助他们自己的写作，无论是现在和未来。

什么样的人会成为读者?

首先是组织和客户，但可能的同事会发现这个页面很有用。从本质上来说，它是为消防安全官员和消防顾问准备的，其次，它是为任何可能发现它有用的人准备的，研究人员和项目负责人，他们可能会在构建论文时得到帮助。

他们有多少人?

这个问题没有答案，成千上万的人都无法回答。然而，它并不重要，因为它只需要一份副本，可以让尽可能多的人阅读。

他们对这门学科的知识水平如何?

如果他们会说英语，他们在理解主题和内容方面不会有困难。然而，英语不是第一语言的人可能希望阅读它，所以内容将需要强调实践和计划的报告写作。

类别:188beat365

2011年4月1日[最后更新:2022年2月10日]