技术写作的组成部分是什么?

(图片由Unsplash dot com上的Rawpixel提供)

答案取决于您所指的技术写作的“ 组成部分 ”。

我们可以通过两个向量来解决这个问题:技术写作过程的组成部分和技术写作产品的组成部分,它们当然是技术文档本身。

(1)技术写作过程的组成部分

(1a)首先是分配,因为除非有分配,否则几乎没有技术作家会开始写任何东西。 您需要具有文档问题的客户或经理,您可以针对该问题提供文档以解决该问题。

(1b)范围听众是任何作业中两个最重要的方面。 您是为谁(观众)写作的? 您应该将什么包括在文档中(从范围中排除)? 这是在触摸键盘之前需要清楚回答的两个问题。

(1c)接下来是研究 。 您需要遍历现有的相关文档,尤其是如果您正在编写的是现有文档的新版本。 您需要确定您的中小型企业(主题专家)是谁,并通过与他们进行面谈并使他们对任何问题保持接触来使他们参与其中。

(1d)接下来是文档计划 。 这是您要去的地方和目的地应该是什么样的路线图。 我在我的网站上写了很多有关文档计划的文章。 您可能想查看此博客文章,例如:如何编写文档计划

(1e)编写第一稿是下一步; 将自己粘在椅子上并敲击键盘的实际过程。

(1f)审核+修订并根据需要生成尽可能多的草稿是下一步。

(1g)按照所需格式 (PDF,电子书,帮助文件,Wiki等)分发可交付成果是最后一步。

(2)技术写作产品的组成部分

以下是上述过程的产物,是技术文档的组成部分:

封面

  • 文件的标题。
  • 文件编号。
  • 文档版本。
  • 软件的标题(如果是软件文档)。
  • 软件版本(如果是软件文档)。
  • 文档的发布日期。
  • 版权声明,日期。
  • 图形或产品图像。
  • 企业徽标。

前事项页

  • 没有页码。
  • COPYRIGHT声明,日期和其他与知识产权相关的专有文本。
  • 文档中提到的各种品牌的TRADEMARK声明。
  • 公司信息。
  • 联系人,网站等信息。
  • 免责声明文字。
  • 披露文字。

目录(TOC)

  • 传统上以PAGE NUMBER“ iii”(小写罗马数字“ 3”)开头。
  • 图形列表(如果有)标题和页码。
  • 列表表标题(如果有)和页码。
  • 其他列表(如果有)标题和页码。
  • 章节标题和页码。 (1级)
  • 缩进的SECTION标题和页码。 (等级2)
  • 缩进的小节标题和页码。 (等级3)
  • 等等。
  • 词汇表标题和页码。
  • 附录标题和页码。
  • 附录标题和页码。
  • INDEX标题和页码。

图形清单(LOF)

  • 数字和页码的标题。 紧随TOC之后。

表格列表(批次)

  • 表和页码的标题。 紧随LOF之后。

其他清单

  • 其他带有标记(例如“作者”)和页码的文档对象的标题。

第1章

  • 章节目录(可选)
  • 章标题(可选:Runner标题)
  • Chapter Footer(可选:Runner Footers)
  • 页码。
  • 文件标题,数字,日期(可选)。

……(随后)其他章节……

词汇表

  • 具有2列的表:“项目”和“说明”。这可以是技术术语,首字母缩写词,缩写词或这三者的组合的词汇表。

附录和附录

  • 参见章…

指数

  • 索引项在字母下方按字母顺序显示,后跟数字条目。
  • 最多三个缩进级别。

封底

  • 企业徽标。
  • 公司地址,传真和电话号码,网址。
  • 版权声明,日期。

我希望这可以帮助🙂

祝您好运!

有关免费的技术写作技巧,请访问©技术交流中心,LLC