关于编写优秀的文档：写什么？
2009年 十一月 11日
Django框架作者Jacob Kaplan-Moss写了一篇帖子，介绍为何编写好的文档很重要：
我喜欢Django文档。打印出来它刚好700页，大部分的内容很清晰，简洁而且很有用。我认为Django是文档写得最好的开源项目之一，我对此感到最自豪。
…
技术文档可以有各种不同的形式，从高度概括的介绍文档，到一步步介绍的详细文档，到系统自动生成的API文档。很不幸，没有任何单独一类的文档能满足所有用户的需求。用户学习的方式千差万别，所以一个文档编写得好的项目必须提供很多不同类别的文档。
总的来说，您可以把用户所需的文档类别分为以下三类：
- 一步一步介绍的辅导文档(tutorial)；
- 用来介绍你的项目的概述和概念的文档；
- 十分底层，非常详细的参考手册。
尚无评论
