软件开发中13种文档 - 软件问题报告

一、前言

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

① 可行性分析报告

② 项目开发计划

③ 软件需求说明书

④ 概要设计说明书

⑤ 详细设计说明书

⑥ 用户操作手册

⑦ 测试计划

⑧ 测试分析报告

⑨ 开发进度月报

⑩ 项目开发总结报告

①① 软件维护手册

①② 软件问题报告

①③ 软件修改报告

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

二、软件问题报告描述

指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。

1 登记号

由软件配置管理部门为该报告规定一个唯一的、顺序的编号。

2 登记日期

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

3 问题发现日期

发现该问题的日期和时间。

4 活动

在哪个阶段发现的问题，分为单元测试、组装测试、确认测试和运行维护。

5 状态

在软件配置记录中维护的动态指示，状态表示有：正在复查"软件问题报告"，以确定将采取什么行动；"软件问题报告"已由指定的人

去进行处理；修改已完成，并经过测试，正准备交给主程序库；主程序库已经更新，主程序库修改的重新测试沿未完成；做了重新

测试，问题再现；做了重新测试，所做的修改无故障，" 软件问题报告"被关闭；留待以后关闭。

6 报告人

填写"软件问题报告"人员的姓名、地址、电话。

7 问题属于什么方面

区分是程序的问题，还是模块的问题，或是数据库的问题，文件的问题。也可能是它们的某种组合。

8 模块/子系统

出现的模块名。如果不知是哪个模块，可标出子系统名，尽量给出细节。

9 修订版本号

出现问题的模块版本。

10 磁带

包含有问题的模块的主程序库的磁带的标识符。

11 数据库

当发现问题时所使用数据库的标识符。

12 文件号

有错误的文件的编号。

13 测试用例

发现错误时所使用测试用例的标识符。

14 硬件

发现错误时所使用的计算机系统的标识。

15 问题描述/影响

问题症兆的详细描述。如果可能，则写明实际问题所在。也要给出该问题对将来测试、接口软件和文件等的影响。

16 附注

记载补充信息。