更新时间：2021-06-09 11:00:42作者：admin2
正文如下：
我不知道是不是有人会将阅读或书写技术文档当做爱好。虽然很讨厌这样做，但是通常为了解决问题或介绍一个技术产品，我们不得不去做这些事情。要想写好文档很难。技术文档有几种形式：基本概览，高级概览，一步一步的演示，自动生成的文档，等等。考虑下不同用户对你的文档的需求情况：不同的需求，不同的技术，不同的学习风格。你将会发现，没有一种格式能同时适应所有人。受众情况在写项目文档的时候，你首先要考虑到的是读者。最终用户首先需要的是一份入门指南。尽管一些技术概念可能会提到，但是重点应放在用户界面，而不是后台。如果是程序员，他可能会想得到更多的信息：程序运行原理，代码的实现，怎样对代码进行扩展，等等。为部分用户写的文档不应当影响到另一部分用户的阅读，你可以考虑写两份单独的文档，用户使用手册和技术文档。几种不同类型的文档 Jacob Kaplan-Moss在他的怎样写好文档的指南中，他提到了三种文档：教程，专题指南和参考指南。
教程：教程是很重要的，因为这往往是用户在使用新的工具时得到的第一印象。我们之前写到过，有许多不同的工具可以帮你写好教程。如果你想写的话，Kaplan-Moss建议你写得简单快速一些，但是不要太简单了，可以做一个演示，为每一步骤添加相关的截图。专题指南：Kaplan-Moss说这是文档的主要内容。虽然教程提供了一个高层次的概念，但是专题指南可以让感兴趣的人深入学习，内容一定要详尽。Kaplan-Moss提到，一般来说，图书要胜过官方文档，但是后者的一个优点是随时更新。参考指南：参考指南是为那些已经入门但是还需要更多信息的用户准备的。为那些已经知道怎样使用API，但是需要查找确切的函数参数或详细设置信息的用户定制的。要指出的是，参考指南是无法由教程和普通指南替代的。自动生成的文档只能起一个引导作用，如果没有额外的写作，编辑和组织，它是不可能解决大家的问题的。虽然这是“技术写作”，但是这并不意味着你应该放弃文采，语法和拼写检查。至少得检查一下语法和拼写吧。