软件工程文档,不得不说是一款软件面向未来的生命。软件开发在“基业常青”的道路上,需要解决和克服的问题太多,现在就机房收费系统开发时出现的问题——沟通和修改谈谈自己的体会。沟通,是未来大型软件开发顺利进行的渠道。修改是软件优化的基础。这两样作为软件开发活动中不可忽略的重要方面,应该已经引起了越来越多人的重视。那么如何做到这点呢,答案就是——文档。在软件开发中,软件文档的存在与否直接影响着软件开发的协同合作的效率已经软件后期的维护。其实文档的作用还有很多,他能让用户和开发者都有一个可靠的准则,让其都有章可循,有“法”可依。无论谁在那一阶段出现问题,都可以通过文档得到解决或者帮助。
下面我们先从软件周期说起:软件周期总的来说分为三个时期——软件定义,软件开发,运行维护。每一个时期又分为多个阶段。
通过上图,我们大致了解了每个文档的生成阶段,下面我们再来详细的说明一下各文档的大致要求。
文档名 | 编写时期 | 编写人 | 预期读者 | 使用的工具 |
可行性研究报告 | 定义 | 分析员 | 用户 项目负责人 |
|
项目开发计划 | 定义 | 分析员 | 用户 项目负责人 |
|
软件需求说明书 | 定义 | 分析员 | 用户 项目负责人 | 系统流程图 结构图 |
概要设计说明书 | 开发 | 技术工程师 | 开发人员 | 逻辑模型
|
数据库设计说明书 | 开发 | 技术工程师 | 数据库管理员 | 数据流图 数据字典 |
测试计划 | 开发 | 测试工程师 | 测试人员 |
|
详细设计说明书 | 开发 | 技术工程师 | 开发人员 | 程序流程图 N-S图,PAD图,伪代码 |
数据要求说明书 | 开发 | 技术工程师 | 数据库管理员 |
|
测试分析报告 | 开发 | 测试工程师 | 测试人员 项目经理 |
|
项目开发总结报告 | 开发 | 技术工程师 | 项目经理 |
|
操作手册 | 开发 | 技术工程师 | 用户 |
|
用户手册 | 开发 | 技术工程师 | 用户 |
|
开发进度月报 | 开发 | 技术工程师 | 项目经理 开发经理 |
|
维护手册 | 维护 | 维护工程师 | 维护工程师 |
|
总共12个文档,当我们把这12个文档完成时,说明我们软件开发已经完成了,可以开始下面的工作了。