怎样编写文档

大部分的技术人员，都很害怕写文档。除了因为理工科学生，语文基础相对较差的因素之外，平时对语言文字方面的表述较少注意也是原因之一，更重要的是，对于如何写文档，总是苦于不知道怎样落笔去写。所以要求技术人员写文档的时候，经常听见该技术人员提出的要求是：有无模板？好象没有了模板，自己就不知道该怎么写，不知道该写什么了。

这篇文章是笔者在长期写文档的过程中总结出来的一些经验，希望能对改善大家畏惧写文档的心理起到一定的作用。
    言归正传，要写好文档，首先要重视文档，要明确文档在项目、团队中的作用：
    1、对过程的完整记录
    2、为持续改进提供文字基础
编写文档，记好下面的三部曲：
    1、把握：目的、主题、读者
    2、明确：脉络、内容
    3、检查：修辞、样式
    每时每刻都要牢牢地把握住文档的目的、主题和面向读者，在动笔之时需要明确文档的脉络和内容，在写完之后要检查修辞和样式。
    目的：明确文档的用途。用于评审和用于内部交流的文档，差别可能非常大。工作报告和工作总结也有本质上的区别。
    主题：文档内容需要围绕这个主题来写，不能偏题，不能离题。这个无需赘述。
    读者：是指阅读对象。提供给客户和开发人员的文档，其侧重点会有所不同，所使用的术语也有不同程度的区别。
    脉络：按照人对事物的认识，大致分为从整体到局部，由浅入深，由外到内，由内到外，由过去到现在到将来等等几种模式。写文档也是一样，根据前面定的文档的目的，主题和读者，决定你要选择的文章组织脉络，例如需求分析文档，应先阐述系统产生背景，然后到业务现状及困境，然后到明确需求等等的脉络结构是比较合适的。
    内容：按照脉络填充。前面脉络定好了，填充内容相对而言比较简单了，也因为不同的文档，不一而足，这里不展开讨论。
    修辞：根据文档的目的、主题和读者，选择不同的修辞方式。例如写给上级用的工作总结，适宜选择书面化的表述语气。写给同事的培训文档，可以写得比较轻松诙谐一点。
    样式：外观格式化。表格是否比文字更好，图表是否应用到位。文章段落格式是否美观等等。
结合这些因素，其实你会发现，写一份文档，其实并不难。至少不比你当初想象的难。