什么是模块化写作
模块化写作(英文:Topic-based authoring 或 Topic-based writing)是一种以主题(英文:Topic)为模块进行内容创作的写作方式,是编写各类技术文档是最常用的方式之一。这种写作方式与当前线性的写作方式形成鲜明的对比,各个不同的主题模块会根据不同的内容来自由组合或重用,每个主题是一个独立的内容模块,包含标题和内容(有时可以只有标题)向读者提供一段完整的信息。各个主题之间可以互相嵌套,也可以独立存在。根据结构化资讯标准促进组织(OASIS)发布的达尔文信息类型架构(DITA)规范,主题可以分为概念、任务、参考、术语表和故障排查五种类型。
简单来说,模块化写作就是写出一个个独立的内容模块。“独立的内容模块”可以是一个标题加上几段话,也可以仅仅是一个标题。它的评价标准也很简单:如果这段内容单独成文依然合乎情理,那它就是一个“独立的内容模块”。
举例而言,这篇文章《模块化写作》就是一个独立的内容模块。我既可以把它单独作为一篇文章、仅解释什么是模式化写作,也可以把它作为其它文章中的一小节、把模块化写作作为背景知识介绍给读者。无论哪种方式都是合乎情理的。
为什么要进行模块化写作
模块化写作的优点显而易见。
- 提升阅读体验。现如今,读者在搜索信息时所得到的信息多是碎片化的,用户需要自行整合信息以构建完整的逻辑体系来解决实际问题,这样做既费时又费力。模块化写作的目的就是让一篇文章自成体系——读者只要按照文章所列的步骤操作,就能够解决他所遇到的问题。
- 便于内容重用,降低维护成本&#x