缘起 一个合格的可维护项目,必须要有足够的文档,因此一个项目开发到一定阶段后需要适当的编写文档.项目的类型多种多样,有许多项目属于内部项目,例如一个内部的开发引擎,或者一个本身就是面向开发者的项目. 本文考虑的是这种面向开发者的项目文档编写.通过本文,你将快速获得如下技能: 理解开发项目文档的基本要素 掌握编写有头有尾结构化文档的能力 获得1个开发项目文档编写的模版项目和现成工具 感受 在开始之前,我们先通过几个现成的例子,直观的感受一个面向开发者的项目,其专业的文档应该是什么样的.我们通过直接…