此文主要是从各个文档要干什么、大概要包含什么内容(与UML的图相结合)以及写完了要交给什么人看等几个方面加以总结。
1,可行性研究报告:
说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施的方案,说明并论证所选定实施方案的理由。最后由决策者判断是否开始实施此项目。
读者:开发人员、项目负责人和决策者
2,软件需求说明书:
也称软件规格说明书,其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议,也是实施开发工作的基础。
读者:用户、开发人员
3,项目开发计划:
为软件项目实施方案制定出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门,并作为开发阶段评审的参考。
读者:决策者、项目负责人、开发人员
4,数据库设计说明书:
该说明书应给出数据逻辑描述和数据采集的各项要求,通过数据库的外部设计、结构设计、运用设计对数据库进行详细的描述,为生成和维护系统数据作好准备。
读者:数据库建立人员和数据库管理者
5,概要设计说明书:
该说明书是概要设计阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计奠定基础。
读者:设计人员、项目负责人
6,详细设计说明书:
着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。以文档驱动开发的模式就要求详细说明书通过流程图以及类图、包图、构件图、用例图等将软件的结构细化,为编码人员能的开发制定标准
读者:开发人员
7,测试计划:
为做好组装测试和确认测试,需为如何组织测试制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
读者:编码和测试人员
8,测试分析报告:
测试工作完成以后,应提交测试计划执行情况的说明。对测试结果加以分析,并提出测试的结论意见。
读者:开发人员和项目负责人
9, 用户手册:本手册详细描述软件的功能、性能和用户界面,使用户了解如何使用该软件。
读者:用户
10,操作手册:
本手册为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节。
读者:用户
11,开发进度月报:
该月报系软件人员按月向管理部门提交的项目进展情况报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
读者:项目负责人和决策者
12,项目开发总结报告:
软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力。此外还需对开发工作作出评价,总结出经验和教训。
读者:决策者和项目负责人
主要注意以下几点:
1、需求分析要有用例图和原型图和简单的数据描绘
2、项目开发计划要有甘特图
3、数据库设计要有ER图和关系模型
3、概要和详细设计要有流程图、类图、时序图、包图和ER图
4、测试计划要有测试用例