The documentation system

文档的大一统理论

• David Laing

要写出好的软件文档, 我们需要先明白一个不太为人熟知的关键: 文档不是一样东西，而是四样.

它们分别是: 教程(Tutorial), 怎么做指南(How-to guides), 技术参考(Technical reference), 和解释(Explanation). 它们分别有各自不同的功能和目的, 也需要四种不同的方法来创建它们. 了解这一点将会有助于改进大多数的文档写作过程 -- 而且通常效果很好.

关于这个系统

这里阐述的文档系统是一个简单, 全面而且几乎普遍适用的方案. 它已经在广泛的领域和应用中得到了实践证明.

管理文档的精要原则很少被详细的解释. 尽管它们不应该像秘密一样, 但似乎想机密一样很少被人熟知.

如果你能够将这些原则应用到实践中, 它会使你的文档更好, 而且使你的项目, 产品和团队更成功 -- 这是一个承诺.

这个系统被无论是大还是小, 开放或者私有的文档项目广泛地采用了 .