文档有四种，包括：教程、操作指南、技术参考和解释。
好的文档使你的项目、产品或团队更加成功。
通常试图创建良好文档的人都以失败告终，失败并非不够努力，只是因为没有以正确的方式做事。
教程面向学习，让新人上手，常见形式如一堂课。
操作指南面向一个目标，展示如何解决特定的问题，常见形式是一系列的步骤。
参考面向信息，机械的描述，常见形式是直白的描述。
解释面向理解，解释术语等等，常见形式是介绍背景、历史、原理。
文档维护人员的困难是不清楚应该写什么，怎么写。明确的区分四种文档，有利于解决这个问题。
对于读者，在学习和工作之间，都能找到适合当时需求的文档类型。
教程是引导读者通过一系列步骤完成某种项目的课程，以学习为导向，在教程的指导下，读者将执行一系列的动作以达到某种目的。
读者需要边做边学，通过做来学习，学习者所做的一切能够立即看到结果，这些事通常很小，很易理解。
教程关注具体的步骤而不是抽象的概念。提供最少的必要的解释。只关注需要采取的步骤，专注于手头的任务。
教程和操作指南都与步骤有关，操作指南和技术参考都是在工作时需要的，参考指南和解释都与理论知识有关。
当我们学习时，教程和解释是最有用的，当我们工作时，操作指南和技术参考是最有用的。
这四种文档相互混合是文档变得混乱的根源。
参考链接: