本页介绍不同的内容类型、各自的使用场景，以及针对每种类型的写作要点。
使用 Diátaxis 框架进行分类
- 教程：面向新手的学习型内容
- 操作指南：面向具体问题的任务型指导
- 解释：以理解为目标的概念性阐释
- 参考：以信息为主的技术性说明
选择类型
| 问题 | 教程 | 操作指南 | 参考 | 解释 |
|---|---|---|---|---|
| 用户的目标是什么？ | 通过实践学习 | 解决特定问题 | 查找精确信息 | 理解概念 |
| 用户的知识水平？ | 初学者 | 中级 | 资深 | 任意水平 |
| 主要关注点是什么？ | 以实操学习为主 | 达成具体目标 | 提供准确信息 | 加深理解 |
| 内容如何组织？ | 按步骤进行 | 问题—解决方案 | 结构化事实 | 概念性讨论 |
| 是否以任务为导向？ | 是，包含引导性任务 | 是，具体任务 | 否，信息型 | 否，概念型 |
| 是否为线性进度设计？ | 是 | 否 | 否 | 否 |
针对各类型的写作指南
教程（以学习为导向）
- 读者目标：通过分步指导学到新知识。
- 特征：按顺序展开，且不预设任何背景知识。
- 写作方法：
- 先说明读者阅读后将达成的成果。
- 使用清晰、循序递进的步骤。尽量减少需要由读者自行做出的选择。
- 过程中指出阶段性里程碑。
- 尽量少谈理论，聚焦具体操作。
操作指南（问题导向）
- 受众目标：正确完成特定任务。
- 特点：以目标为导向，默认读者具备一定的相关知识。
- 写作方式：
- 以用户视角撰写，而非产品视角。
- 按照合乎逻辑的步骤展开，省略不必要的细节。
- 仅保留完成任务所需的最少 context。
参考（信息型）
- 读者目标：查找产品功能的详细信息。
- 特性：清晰无歧义、聚焦产品、便于快速扫描。
- 写作方式：
- 便于扫描且简洁。
- 优先保持一致性。
- 避免解释性内容，侧重于易于复制和修改的示例。
说明（理解导向）
- 读者目标：拓展对某个概念或高度复杂功能的整体理解。
- 特点：偏理论，可能包含主观看法，范围广泛。
- 写作方式：
- 提供背景 context，如设计决策或技术约束。
- 说明不同观点与可选方案。
- 关联到产品或行业中的其他领域。
技巧与提示
- 明确目的：动笔前为每个页面确定清晰的内容类型，并在写作全程始终围绕这一目标展开。
- 关注内容时效：无论内容类型如何，都应尽量打造“常青”文档。如果某些内容只是反映某个功能在特定日期的呈现，更适合放在更新日志或博客文章中，而非文档；若某些内容变化极其频繁，也应避免纳入文档。
- 以用户为中心思考：在组织内容时考虑不同的用户角色。参见了解你的受众以了解更多。