软件工程各阶段的开发文档

软件工程各阶段的开发文档
在我们自己开发项目时，定好目标、想好大致框架就可以着手开发了，不是那么严格。但是，如果是开发一个商业项目，就不能那么随意了。

我们知道，软件工程是一个指导开发者管理项目、开发项目的学科，有很多业内行之有效的开发模型，如：快速原型法、螺旋模型、敏捷开发等等。软件工程把开发一个项目划分成了不同阶段，使得项目开发有迹可循，有条不紊。但是，无论采用什么模型，都离不开一样东西，就是——开发文档。

在实际开发中，开发者如何与不通技术的客户去展示所设想的产品呢？文档（含图片）是最好的选择。而随着项目进展的不同，每个阶段的文档也会随之演变，变得越来越详细。下面我们来大概介绍一套比较简单的开发文档演变流程。

一：开发文档1.0（需求分析阶段）
所需材料：与客户面对面交流，通过一些针对性的引导问题让客户描述目标产品的要求。比如：您遇到了什么样的业务需求？您想做出一个怎样的东西去解决这个问题？
在这个系统中，会有哪些人（用户角色）？您的业务流程是怎样的？每一种角色，分别用这个系统做什么？

生成文档：从采集到的需求资料中得出《开发文档1.0》，主要有三部分内容：
一：系统概述：系统设计初衷（遇到的问题、想系统怎么解决这个问题）
二：用户角色：有什么角色会使用这个系统
三：概要需求：系统的功能、每个角色会怎么使用这个系统

二：开发文档2.0+项目计划书（概要设计阶段）

所需材料：把《开发文档1.0》交予客户审核确认修改。然后同时再次沟通，获取整个系统的使用流程、各个角色的使用流程、整个系统的具体功能列表。

生成文档：《开发文档2.0》：在《开发文档1.0》基础上，补全、新增：
三：概要需求：补全系统使用流程图、各个角色的使用流程图
四：功能列表：得出系统功能列表、每个角色模块的功能列表
五：系统架构：采用什么架构来开发这个系统
《项目计划书》：根据《开发文档2.0》大概估计项目的开发成本（时间、资源），然后针对各个项目模块的功能作出相应报价
一：开发成本汇报：所需时间、人力物力
二：项目模块报价：各个功能模块的功能列表以及实现这个模块的报价
三：整体项目报价

三：开发文档3.0（详细设计阶段）

所需材料：《开发文档2.0》与《项目计划书》交付客户审核、确认、沟通修改，获取客户进一步的要求。

生成文档：《开发文档3.0》：在《开发文档2.0》的基础上新增：
六：功能详细设计：对每个角色的的每个功能进行详细设计，主要包括：

1：功能描述
2：功能流程
3：界面Demo
4：数据规约
5：数据实体

四：开发文档4.0（详细设计阶段）

所需材料：《开发文档3.0》交予客户审核确认，特别是对详细设计部分的功能描述、界面Demo等作出确认。

生成文档：《开发文档4.0》：在《开发文档3.0》基础上新增：

七：模块划分：对角色各个功能进行划分，成为系统的模块。

八：数据库设计：由详细设计部分涉及到的数据实体与数据规约，以及对角色功能划分后得到的系统模块，进行数据库设计（创建什么表？表中属性有哪些？）

五：开发文档5.0（详细设计阶段）

所需材料：《开发文档4.0》

生成材料：根据《开发文档4.0》中的数据库设计，对 第六点：功能详细设计 做出补充完善：

6：设计数据库中的表
7：功能实现的架构（把功能流程用架构表示，如：交互的操作在 XX.jsp，请求传给 xxservlet、数据操作 xx数据表）

六：根据《开发文档5.0》进行编码开发工作，生成《注释文档》

七：单元测试、集成测试、系统测试，生成《测试日志》

八：编写《用户使用手册》，交付并指导客户使用