A文档系统：教程/操作指南/参考/说明

要编写好的软件文档，需要了解一个秘密：文档不是一种，而是四种。

它们是：教程、操作指南、技术参考和说明。它们代表四种不同的目的或功能，需要四种不同的创作方法。理解这一点的含义将有助于改进大多数文档-通常是极大的改进。

这里概述的文档系统是一个简单、全面且几乎普遍适用的方案。在广泛的领域和应用程序的实践中都得到了验证。

有一些管理文档的非常简单的原则，即使有也很少详细说明。他们似乎是一个秘密，虽然他们不应该是。

如果您能够将这些原则付诸实践，它将使您的文档更好，您的项目和制作团队更成功-这是一个承诺。

如果你更喜欢看关于这个话题的视频，这里是(PyCon Australia 2017提供)。