20160408 从软件工程的3大文档开始说起

软件工程的三大文档可以说分3个阶段：需求，概要和详细。

一，需求分析文档

　　简单说来就是与客人沟通，把客人的业务需求整理成为文档。

     需求分析文档中可以有用例描述，开发人员与用户充分沟通后，用用例图将客人的要求表达出来，而用例图能够使他们两者达成共识。

     需求里面也需要放一些其他的东西，比如关于性能描述，非功能性要求等等

 

二，概要设计文档

     我觉得这个是我现阶段作为一个常年工作在生产第一线的人反过来总结自己所做的项目的一个很好的表达方式。理由往下看吧...

     首先概要设计的观看对象是 项目经理和客人，或者是说作为外包公司和甲方的沟通依据。

　　概要设计文档的编写就是要根据需求文档的要求，把系统具体化。将系统的功能进行模块划分，建立模块的层次结构调用关系、确定模块之间的接口和人机界面等等。（有了概要设计，就可以拿着他跟客人吹水，提预算了。）

     概要设计的主要内容，

1. 功能介绍，可以通过画用例图的方式呈现
2. 主要的功能界面，可以参考其他的项目截图，然后PS一下。
3. 数据库的主要架构设计，表设计，体统的整体架构（主要指包图）
4. 编程规范

三， 详细设计

　　详细设计的主要对象就是最终编写代码的人。

　　详细设计文档的主要内容，

1. 系统各个层次之间的接口，如类，方法名，参数，返回值等。
2. 系统时序图（Sequence Diagram），可以说是系统功能顺序图，我们一般可以用UML交互图来呈现，表达用例的顺序行为，（这个目前是我的短板，囧）。开发人员可以对系统的层与层之间的调用关系，方法名、参数、返回值有明确的概念。
3. 其他具体细节， 如系统的精度问题，程序的毕业功能，性能描述等。