撰写易查的文档
想要让文档易查,要做到以下几点:
- 把信息分成概念(concept)、任务(task)和参考(reference)三类。
- 这三类信息对应着三种话题(topic),即概念话题(concept topic)、任务话题(task topic)和参考话题(reference topic)。每个话题只介绍一个主题,比如有个“把大象装冰箱“的任务话题,这个话题只允许讨论把大象装冰箱的步骤,而不允许在这个话题里介绍什么是冰箱,冰箱的主要部件,什么是大象,大象的种类。如果想介绍什么是冰箱,就要新建一个概念话题来介绍什么是冰箱。如果介绍冰箱的部件,就要新建一个参考话题,用插图片或表格来具体介绍冰箱的组成。 通过信息分类,我们可以把信息整理成块,不仅结构上统一,而且还方便查找和重复利用。
- 按照使用顺序组织任务话题(task topic)。
- 把相关的话题放在一起,合理地排列顺序和层级。
- 目录的标题要一目了然;避免下一级目录与上一级目录意思相同或相近。
- 重要的信息写在最前面。
- 提供一个概述话题,介绍整体的结构。
- 添加跳转链接和相关信息链接。
- 提供索引。
- 标题的内容要具体。
- 提供搜索功能。
- 利用标题、加粗、字体、图标、图片、留白等手段提升视觉效果。