【软工】文档

    总结：在软件开发的前中后期，我们需要写许多必要的文档，通过这次试着写文档，我对它们有了初步的了解，也意识到了文档对于软件开发的重要性。

一、开发的阶段

二、文档的读者

有：管理人员、系统分析员、开发人员、测试人员、维护人员、用户

软工文档	读者
可行性研究报告	开发人员、管理人员、维护人员
项目开发计划	系统分析员、开发人员
软件需求说明书	开发人员、用户
概要设计说明书	开发人员
详细设计说明书	开发人员、用户
数据库设计说明书	开发人员、测试人员、维护人员
数据要求说明书	开发人员、测试人员
测试计划	开发人员、测试人员
测试分析报告	开发人员
项目开发总结报告	开发人员
操作手册 用户手册	用户
开发进度月报	开发人员、管理人员

三、各个文档的任务

1.可行性研究报告

从经济、技术、操作、法律、时间的角度说明该系统的开发是否可行

2.项目开发计划

为软件项目实施方案制定出的具体计划。

3.软件需求说明书

阐述用户的需求，对目标软件的功能、性能、用户界面及运行环境等作出详细的说明

4.概要设计说明书

把用户需求划分为几个模块，确定模块结构，划分功能模块

5.详细设计说明书

着重描述每一模块如何实现，确定每一模块使用的算法、数据结构，确定模块接口的细节，为每一个模块设计出一组测试用例

6.数据库设计说明书

提供了数据库的设计的理论支持，对数据库中使用的所有标识、逻辑结构和物理结构做出具体的设计规定。

7.数据要求说明书

给出数据逻辑描述和数据采集的各项要求,为生成和维护系统的数据文件做好准备。

8.测试计划

为了做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

9.测试分析报告

测试工作完成后，应提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论性意见。

10.项目开发总结报告

软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。

11.操作手册

为了给使用者提供一个使用指南，以便为首次使用该系统的用户说明使用方法，解决过程中遇到的问题。

12.用户手册

为了给使用者提供一个使用指南，以便为首次使用该系统的用户说明使用方法，以及给已经使用过或者正在使用的用户在使用过程中遇到问题时提供解决问题的方法。

13.开发进度月报

该月报是软件人员按月向管理部门提交的项目进展情况的报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。