软件开发中13种文档 - 软件修改报告

一、前言

在项目开发过程中文档是很重要的一部分，一个完整的开发流程需要包含以下13种文档：

① 可行性分析报告

② 项目开发计划

③ 软件需求说明书

④ 概要设计说明书

⑤ 详细设计说明书

⑥ 用户操作手册

⑦ 测试计划

⑧ 测试分析报告

⑨ 开发进度月报

⑩ 项目开发总结报告

①① 软件维护手册

①② 软件问题报告

①③ 软件修改报告

且上述十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。下面我们就逐一对每个文档进行说明。

二、软件修改报告描述

软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。

1 登记号

由软件配置管理部门为该报告规定的编号

2 登记日期

软件配置管理部门登记"软件修改报告"的日期。

3 时间

准备好"软件修改报告"的日期。

4 报告人

填写该报告的作者。

5 子系统名

受修改影响的子系统名。

6 模块名

被修改的模块名。

7 "软件问题报告"的编号

被"软件修改报告"处理或部分处理的"软件问题报告"的编号。某"软件问题报告"的问题只是部分被处理，则在编号后附以p，如1234p。

8 修改

包括程序修改、文件更新、数据库修改或它们的组合。

9 修改描述

修改的详细描述。如果是文件更新或数据库修改，还要列出文件更新通知或数据库修改申请的标识符。

10 批准人

批准人签字，正式批准进行修改。

11 语句类型

修改涉及到的语句类型，包括：输入/输出语句类、计算语句类、逻辑控制语句类、数据处理语句类（如数据传送、存取语句类）。

12 程序名

被修改的程序、文件或数据库的名字。

13 老修订版

当前的版本/修订本标识。

14 新修订版

修改后的版本/修订本标识。

15 数据库

如果申请数据库修改，则给出数据库的标识符。

16 数据库修改报告

数据库修改申请号。

17 文件

如果要求对文件进行修改，则给出文件的名字。

18 文件更新

文件更新通知单的编号。

19 修改是否已测试

指出已对修改做了哪些测试，如单元、子系统、组装、确认和运行测试等，并注明测试成功与否。

20 "软件问题报告"是否给出问题的准确描述

回答'是'或'否'。

21 问题注释

准确地叙述要维护的问题。

22 问题源

指明问题来自于哪里，如软件需求说明书、设计说明书、数据库、源程序等。

23 资源

完成修改所需资源的估计，即总的人时数和计算机时间的开销。