技术文件标题

技术写作的主要目的是清晰地解释困难的事情。 为了 使大文本易于理解技术写作人员通常将信息分成小块,并在标题上加上标签。 标题应显而易见,并传达本节的含义。 那么如何正确组织您的文档呢? 继续阅读本文!

首先,让我们谈谈技术写作文档本身。 最好使用短句并保持您的语言简单。 这将使您的手册更加易懂。 为此,请简要介绍信息。 因此,如果一个人只想更换火花塞,则无需描述发动机的历史。 人们通常使用手册来解决问题。 这意味着您应该向读者提供技术文档。

所以你应该怎么做:

· 使用适当的样式。 技术文档应包含重点信息。 这就是为什么使用笑话,典故,隐喻等来接受是不可接受的。 这会让读者感到困惑。

· 使用简单的单词。 它可以是“实施”,“结论”,“建议”或“附录”。 标题应描述以下信息。 当然,可能很难用一个词来描述本节的概念。 因此,在头条新闻开头加上重要的文字。 它们将吸引读者的注意力,从而简化搜索过程。

· 使用副标题。 如果该部分很大,请通过副标题将信息细分为较小的块。

· 保持大写风格一致。 有不同的大写规则。 例如,单词的首字母大写或第一个和最后一个单词的首字母大写。 但标题和子标题使用相同的大写样式。

· 使用类似的构造。 例如,如果一个标题以动词开头,那么所有标题都应以动词开头。 这就是所谓的“并行构造”。 当然,如果您的技术写作文档中有很多部分,将很难遵循此规则。 因此,请适当使用它。

· 使用编号进行结构化。 在标题的开头,您可以使用数字。 通常,阿拉伯数字用于此目的。 因此,对于标题使用句点(1.,2.,3。),子标题以带有小数点后一位的数字开头,然后是句点(1.1。,1.2。,1.3。),依此类推。 此方法通常用于工程程序。

您可能已经注意到,这些技巧是根据提到的规则组织的。 我想您会同意,这样您可以更轻松,更快地感知信息。 因此,请遵循我的建议,您的技术书面文件将为您带来成功。


我如何成为技术作家? 您需要什么技能? 阅读 有关技术写作的常见问题

技术写作常见问题

许多对技术写作感兴趣的人经常问我许多不同的问题,但这是…

medium.com