软件开发需要编写的文档终于完成了,在这里总结一下文档中预期的读者、涉及的图表、每个文档是吗时候写以及每个文档的目的。
文档预期读者与涉及的图表:
文档 | 预期读者 | 文档涉及到的图 |
可行性研究报告 | 项目经理、客户、开发人员 | 数据流图,处理流程图 |
项目开发计划 | 项目经理、用户、开发人员 | 甘特图 |
软件需求说明书 | 开发人员、维护人员、用户 | IPO图、流程图 |
概要设计说明书 | 开发人员、维护人员 | 处理流程图、层次图、结构图 |
详细设计说明书 | 开发人员、测试人员、维护人员 | IPO图、结构图、层次图、结构图 |
数据库设计说明书 | 设计人员、开发人员、维护人员 | 实体—关系图(E—R图) |
数据要求说明书 | 设计人员、开发人员、测试人员、维护人员 |
|
测试计划 | 测试人员 |
|
测试分析报告 | 开发人员、维护人员 |
|
项目开发总结报告 | 项目经理、开发人员 | 系统流程图 |
开发进度月报告 | 项目经理,开发人员 |
|
操作手册 | 测试人员、用户、培训人员 | 系统流程图、IPO图 |
用户手册 | 测试人员、用户 |
|
文档对应生存期:
生存期 文档 | 制定计划 | 需求分析 | 设计 | 程序编码 | 测试 | 运行维护 |
可行性研究报告 |
|
|
|
|
|
|
项目开发计划 |
|
|
|
|
|
|
软件需求说明书 |
|
|
|
|
|
|
概要设计说明书 |
|
|
|
|
|
|
详细设计说明书 |
|
|
|
|
|
|
数据库设计说明书 |
|
|
|
|
|
|
数据要求说明书 |
|
|
|
|
|
|
测试计划 |
|
|
|
|
|
|
测试分析报告 |
|
|
|
|
|
|
项目开发总结报告 |
|
|
|
|
|
|
开发进度月报告 |
|
|
|
|
|
|
操作手册 |
|
|
|
|
|
|
用户手册 |
|
|
|
|
|
|
文档的目标:
1.可行性研究报告——研究此软件的可行性和收益情况。
2.项目开发计划——整个系统的规划,引导开发过程。
3.软件需求说明书——根据用户需求来设计软件,确定软件的功能。
4.概要设计说明书——搭建整个软件的设计框架。
5.详细设计说明书——细化开发途径和应用方法,方便开发者最短的时间内完成开发。
6.数据库设计说明书——说明数据库设计结构以及各方面的要求。
7.测试计划——提供测试方案,测试结果记录。
8.测试分析报告——分析测试结果。
9.项目开发总结报告——总结本项目开发工作的经验,写评价,流程,结果,经验教训等。
10.开发进度月报——总结本月开发进度。
11.操作手册和用户手册——给用户提供帮助,使用户在最短时间熟悉系统。
第一次写文档总结,有什么不足之处,欢迎大家提出宝贵的意见和建议。