主题式写作

技术文档写作的一个特点就是主题式写作。这篇博文将介绍什么是主题式写作、它有哪些特点、它和常规写作的区别是什么、主题式写作都包含哪些主题以及为什么技术文档要采用主题式写作。

什么是主题式写作（topic-based writing）

主题式写作指的是将信息拆分为独立且聚焦的小单元，每个主题只讲述一个概念（concept）、任务（task）或参考（reference）内容。例如，一个主题只描述“如何安装打印机”，不会混入其它操作说明。

说到主题式写作，就不得不提达尔文信息类型化体系结构（Darwin Information Typing Architecture），简称DITA，它就是用于支持主题式写作的架构。

主题的基本特点

有明确的标题。
能单独阅读并理解。
结构清晰、聚焦单一内容。
可通过文中的链接和其他主题组成有序的信息网络。

主题式写作与常规写作的区别

传统写作内容连贯、线性，适合写文学或学术文章。而在技术文档写作中，我们要注意到：用户在查找技术信息时，通常希望快速找到“如何操作”的那一页。例如，修理摩托车时，用户不会想读完整本手册，而是想直接找到“调整油门阀”的步骤。所以技术文档采用的是主题式写作，把内容模块化，而不是像常规写作那样按照故事发展或学术研究的脉络进行写作。

主题式写作有哪些主题类型

类型	用途说明	示例标题
概念	说明背景、原理或“是什么”，例如介绍用户权限的含义	User roles（用户角色）
任务	描述步骤和操作，即“怎么做”，通常按顺序编排	Create user roles（创建用户角色）
参考	提供数据、命令、参数或组件信息，帮助用户快速查阅	Supported types of roles（支持的角色类型）

主题式写作对读者有哪些好处

用户通常只需要小块信息来完成某项任务，例如“如何连接Wi-Fi”。
避免阅读冗长或混乱的内容，有助于提升查找效率。
主题间可链接，构建出信息网络，如网站的跳转链接。

主题式写作对写作团队有哪些好处

多人可并行编辑不同主题，比如一位作者写“安全设置”，另一位写“安装准备”。
通用的主题可以在不同文档中重复使用，比如某公司开发了很多种软件，但是这些软件的登录步骤都一样，文档工程师只需要写一个“登录某系统”的主题，其他软件的文档就可以直接把这个主题拿来用，而不必再给每个软件都重新写一个“登录某系统”的主题。
内容重组更灵活，如根据产品变更，只需调整任务顺序。
审阅工作更轻松，小块内容更便于快速反馈。

主题式写作-介绍