软件产品文档系统的方法论 —— 如何组织和编写软件产品文档

参考：https://docs.divio.com/documentation-system/

注：这个网站链接是我们的CTO周悦秋先生推介的，可以作为软件文档撰写的方法论，我读过之后觉得确实如此，可以按照这种结构和思路去编写真正适合用户阅读的文档。

要想编写出一个好的软件产品文档，我们需要把文档分为四个部分或者四类，分别是 基础教程（tutorials）、 操作 指南（how-to guides）、 技术参考（technical reference）和 解释说明（explanation）。

这四部分中的每一部分都有不同的目的或者功能，理解这些有助于改进我们的文档系统，而且是极大改进。

1. 基础教程

基础教程是面向学习的，它有可操作性，对快速学习和掌握很有帮助。当我们想了解和学习它时应该去阅读这一部分。

2. 操作指南

操作指南是面向解决问题的，它具有可操作性，重点是如何使用。当我们以此工作或者需要利用它做成某件事情时应该去阅读这一部分。

3. 技术参考

技术参考是为了方便我们去查阅某个信息而生的，它的技术性知识更强，偏向于使用阶段。

4. 解释说明

解释说明是为了方便我们去理解某个知识点，技术性较强，它的目的是为了我们深入的研究和理解某个地方，偏向于研究学习。