浅谈文档

前言：这篇博客其实写了很久了，总是不满意，总是感觉写的不够严谨，所以修改了好几次都没有发表，这次在技术交流会议上，我们就文档进行了较深入的探讨，于是结合之前的草稿我进行了整理，不足之处，请多多指教。

文档的地位

百科上是这样说的：文档是软件开发使用和维护中的必备资料。文档能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导、帮助、解惑的作用，尤其在维护工作中，文档是不可或缺的资料。
事实上我们可以这样理解：首先文档是我们确定项目金额的直接凭证或者说是公司和客户之间沟通的书面表达，其次是我们项目小组在合作开发过程中沟通的桥梁，很多东西写到文档里，也是一种责任的明确；最后，也是很重要的一点，它是我们后期维护的主要参考资料，对于维护人员来说，文档的好坏直接决定他维护的难度，有些太过糟糕（几乎没有参考价值的文档），可能导致的后果是当初开发小组的成员离职后，后期的维护人员根本就无法接手后面的工作。

文档的内容

1.文档中要放实实在在的东西（每个角色最需要看到的东西）；
2.不要说废话，尽量保证每句话都有意义，无意义的不要写进去；
3.具体的文档中对应的内容（主要文档）

（1）项目计划：进度安排和说明（甘特图）

（2）需求文档：原型图，用例，用例说明，IPO图（输入输出处理)

（3）概要文档：界面，架构图（粗粒度）

（4）详细文档：编码时用，看了文档就要能写出代码，包括包图（架构图），用例（用例说明），类图（类图说明，方法，参数，参数说明），接口（接口说明），时序图（下注解释，或用表格解释）--一个图一个说明，有图有真相。

（5）数据库设计说明书：表，表结构，视图（下注解释），Sql语句，脚本注释，数据库关系图，（包括事务，存储过程）；

（6）测试文档：每次测试用例记录，集合测试，单元测试

（7）用户手册：修改历史和界面描述（界面描述要图文结合，最好的注释是在图上标记符号和文字，其服务对象主要是面向用户） 

再教你一个简单判断文档内容的方法：当你在考虑一个文档里应该放什么内容时，你只要问自己下面四个问题就可以了：然后根据答案选择要文档中需要放入的内容。