软件缺陷管理系统需求与设计样本.doc

软件缺陷管理系统需求与设计
( 软件文档写作课程设计)

姓名: 于家鹏
班级: 070608
学号:

软件缺陷管理系统需求规格与设计说明书
Prepared by
拟制
于家鹏
Date
日期
-10-28
Reviewed by
评审人

Date
日期

Approved by
批准

Date
日期

1 Introduction 简介
1.1 Purpose 目的
本文档为软件缺陷管理系统项目的需求规格说明书, 规范的定义本软件项目的需求。该项目计划的阅读人员包括项目经理、 项目总监以及项目组中的所有成员。
1.2 Scope 范围
本文档包括:
软件总体概述
功能需求
性能需求
接口需求
总体设计约束
软件质量特性
General description总体概述
本项目软件需求由项目经理提供, 项目组经过需求调研( 网上查阅相关资料和同类产品比较) , 对需求进行裁剪。
1.3 Software perspective 软件概述
1.3.1 About the Project 项目介绍
本系统是缺陷跟踪管理的专业软件, 它用于帮助公司和团队跟踪工作中的问题, 管理和记录这些问题的处理过程。经过此系统能够整合客户、 开发人员、 测试人员, 各人各司其职, 信息很快得到交流和反馈, 让大家感到软件开发在顺利快速的进行, 朝意想的目标迈进。它的主要作用是为开发人员服务, 实时将信息反馈给开发人员, 开发人员同时迅速地将修复的结果信息反馈到跟踪系统中, 最后经过持续集成, 软件迅速地完成了更新, 这些方便、 便捷的操作会极大地鼓舞软件开发中的各方人员, 甚至包括客户, 及时响应。
1.3.2 Environment of Product 产品环境介绍
本软件产品运行在装有java运行环境的任何操作系统上运行。
1.4 Software function 软件功能
功能模块
用例
一. Bug管理
1. Bug管理
2. 分配给我的bug
3. 我创立的bug
4. Bug查询
二. 项目管理
1. 项目管理
2. 用户组管理
3. 版本管理
4. 查询统计
三. 用例管理
1. 测试用例管理
2. 测试计划管理
3. 用例测试结果管理
四. 系统管理
1. 用户管理
2. 权限管理
3. 测试类别管理
4. Bug级别管理
表格 1 软件功能表
1.5 Actors
Actor为软件研发的项目经理, 开发人员和测试人员
2 Functional Requirements 功能需求
2.1 Use Case Diagram 系统总用例图

2.2 系统活动图

2.3 系统子用例图
2.3.1 Project.Module01.Function01 bug管理-bug管理
2.3.1.1 Goal in Context 简要说明
检索与维护所有项目的BUG的状态信息, BUG一共由8种状态。
状态1: 已提交: 测试员发现 BUG 后提交到 BUG 管理系统中的状态。( 初始状态)
状态2: 已修改: 程序员在修改了 BUG 后提交到 BUG 管理系统中的状态。
状态3: 不修改: 程序员或项目经理根据需求分析、 概要设计、 详细设计说明书等上的要求经过考虑后决定对 BUG 不进行修改。其 BUG 的状态为不修改, 需要说明理由。
状态4: 延迟: 根据当前项目进程或计划等情况, 暂时延期的状态
状态5: 待讨论: 需要进行讨论后才能决定是否需要修改的 BUG 的状态。
状态6: 已验证: 已经解决的并经过测试员复测的 BUG 的状态。
状态7: 关闭: 完全解决了, 只供以后备查的状态
状态8: 重新打开: 重新出现在新的版本中, 重新打开以前关闭的 bug 状态 。
2.3.1.2 Preconditions 前置条件
无
2.3.1.3 End Condition 后置条件
无
2.3.1.4 Actors
所有人员。
2.3.1.5 Trigger 触发条件
无
2.3.2 Project.Module01.Function02 bug管理-分配给我的bug
2.3.2.1 Goal in Context 简要说明
测试人员对对象软件进行测试发现了bug后分配给开发人员。
2.3.2.2 Preconditions 前置条件
测试人员发现了bug。
2.3.2.3 End Condition 后置条件
获取bug信息。
2.3.2.4 Actors
开发人员。
2.3.2.5 Trigger 触发条件
测试人员发现了bug。
2.3.3 Project.Module01.Function03 bug管理-我创立的bug
2.3.3.1 Goal in Context 简要说明
根据测试人员给开发人员提供的bug信息创立一个处理这个bug的功能模块。
2.3.3.2 Preconditions 前置条件
获取bug信息。
2.3.3.3 End Condition 后置条件
处理好这个bug以后, 将信息交给测试人员。
2.3.3.4 Actors
开发人员。
2.3.3.5 Trigger 触发条件
获取bug信息。
2.3.4 Project.Module01.Function04 bug管理-bug查询
2.3.4.1 Goal in Context 简要说明
查询bug信息的一个功能模块。
2.3.4.2 Preconditions 前置条件
无。
2.3.4.3 End Condition 后置条件
无。
2.3.4.4 Actors
所有用例。
2.3.4.5 Trigger 触发条件
无。

2.3.5 Project.Module02.Function01 项目管理-项目管理
2.3.5.1 Goal in Context 简要说明
根据需求, 实际情况, 创立项目。
2.3.5.2 Preconditions 前置条件
了解需求, 条件允许
2.3.5.3 End Condition 后置条件
创立用户组
2.3.5.4 Actors
项目经理
2.3.5.5 Trigger 触发条件
无
2.3.6 Project.Module02.Function03 项目管理-用户组管理
2.3.6.1 Goal in Context 简要说明
根据项目需求, 选择合适人员, 组成项目组
2.3.6.2 Preconditions 前置条件
项目已经建立
2.3.6.3 End Condition 后置条件
制定项目计划
2.3.6.4 Actors
项目经理
2.3.6.5 Trigger 触发条件
该项目已经立项, 项目计划已经建立
2.3.7 Project.Module02.Function03 项目管理-版本管理
2.3.7.1 Goal in Context 简要说明
对 每一次出现bug并修改后的被测项目的版本进行修改。
2.3.7.2 Preconditions 前置条件
开发员对当前bug修改完成。
2.3.7.3 End Condition 后置条件
修改被测项目的版本。
2.3.7.4 Actors
项目经理。
2.3.7.5 Trigger 触发条件
当前Bug修改完成。
2.3.8 Project.Module02.Function04 项目管理-查询统计
2.3.8.1 Goal in Context 简要说明
查询反馈信息中已关闭的bug数量, 来得到被测试项目某阶段解决bug的程度。根据bug的解决程度用来控制被测项目的进度。

2.3.8.2 Preconditions 前置条件
无。
2.3.8.3 End Condition 后置条件
统计已关闭bug的数量。
2.3.8.4 Actors
项目经理。
2.3.8.5 Trigger 触发条件
反馈信息确定。
2.3.9 Project.Module03.Function01 用例管理-测试计划管理
2.3.9.1 Goal in Context 简要说明
管理所有的测试计划, 并能够添加、 删除、 修改、 查询测试计划。
2.3.9.2 Preconditions 前置条件
制定项目计划。
2.3.9.3 End Condition 后置条件
编写测试用例。
2.3.9.4 Actors
软件 测试人员。
2.3.9.5 Trigger 触发条件
项目计划的制定。
2.3.10 Project.Module03.Function02 用例管理-测试用例管理
2.3.10.1 Goal in Context 简要说明
用来管理测试用例: 能够对测试用例进行添加、 删除 、 修改、 查询。
2.3.10.2 Preconditions 前置条件
编写测试计划。
2.3.10.3 End Condition 后置条件
管理所有bug。
2.3.10.4 Actors
软件测试人员
2.3.10.5 Trigger 触发条件
测试计划的编写。
2.3.11 Project.Module03.Function03 用例管理-用例测试结果管理
2.3.11.1 Goal in Context 简要说明
在使用测试用例进行测试的时候要求测试用例应该包含5种状态,
状态1: 未测试, 说明还没有开始测试。
状态2: 测试经过: 测试用例经过测试。
状态3: 测试不经过: 测试用例没有经过。
状态4: 测试阻塞: 阻塞表示该测试用例的前置条件还未符合, 因此该用例测试没有办法开始进行。
状态5: 测试取消: 取消表示如果测试用例与实际软件实现不想符合, 那么测试用例不能按照实际情况测试, 那么测试用例取消。
2.3.11.2 Preconditions 前置条件
无
2.3.11.3 End Condition 后置条件
无
2.3.11.4 Actors
软件测试人员
2.3.11.5 Trigger 触发条件
当测试人员需要管理用例测试结果的时候
2.3.12 Project.Module04.Function01 系统管理-用户管理
2.3.12.1 Goal in Context 简要说明
创立系统用户
2.3.12.2 Preconditions 前置条件
无
2.3.12.3 End Condition 后置条件
权限管理
2.3.12.4 Actors
系统管理员
2.3.12.5 Trigger 触发条件
该项目已经立项
2.3.13 Project.Module04.Function02 系统管理-权限管理
2.3.13.1 Goal in Context 简要说明
对系统权限的管理
2.3.13.2 Preconditions 前置条件
用户创立
2.3.13.3 End Condition 后置条件
无
2.3.13.4 Actors
系统管理员
2.3.13.5 Trigger 触发条件
用户创立

2.3.14 Project.Module04.Function03 系统管理-测试类别管理
2.3.14.1 Goal in Context 简要说明
软件测试常见的测试方法:
黑盒测试: 不基于内部设计和代码的任何知识, 而是基于需求和功能性。
　白盒测试: 基于一个应用代码的内部逻辑知识, 基于覆盖全部代码、 分支、 路径、 条件。
　单元测试: 最微小规模的测试;以测试某个功能或代码块。
　累积综合测试: 当一个新功能增加后, 对应用系统所做的连续测试。
集成测试: 一个应用系统的各个部件的联合测试, 以决定她们能否在一起共同工作。部件能够是代码块、 独立的应用、 网络上的客户端或服务器端程序。
　　功能测试: 用于测试应用系统的功能需求的黑盒测试方法。
　　系统测试: 基于系统整体需求说明书的黑盒类测试;应覆盖系统所有联合的部件。
2.3.14.2 Preconditions 前置条件
无
2.3.14.3 End Condition 后置条件
无
2.3.14.4 Actors
系统管理员
2.3.14.5 Trigger 触发条件
该项目已经立项

2.3.15 Project.Module04.Function04系统管理-bug级别管理
2.3.15.1 Goal in Context 简要说明
BUG一般分为4个等级分别为
致命(可对应当前BUG体系中的”非常严重”):
致命性问题主要为: 系统无法执行、 崩溃或严重资源不足、 应用模块无法启动或异常退出、 无法测试、 造成系统不稳定。
具体基本上可分为:
○ 内存泄漏
○ 用户数据丢失或破坏
○ 系统崩溃/死机/冻结
○ 模块无法启动或异常退出
○ 严重的数值计算错误
○ 功能设计与需求严重不符
○ 其它导致无法测试的错误
● 严重( 可对应当前BUG体系中的”严重”)
严重性问题主要为: 影响系统功能或操作, 主要功能存在严重缺陷, 但不会影响到系统稳定性。
具体基本上可分为:
○ 功能未实现
○ 功能错误
○ 系统刷新错误
○ 语音或数据通讯错误
○ 轻微的数值计算错误
○ 系统所提供的功能或服务受明显的影响
● 一般( 可对应于当前BUG体系中的”普通”)
一般性问题主要为: 界面、 性能缺陷
具体基本上可分为:
○ 操作界面错误( 包括数据窗口内列名定义、 含义是否一致)
○ 边界条件下错误
○ 提示信息错误( 包括未给出信息、 信息提示错误等)
○ 长时间操作无进度提示
○ 系统未优化( 性能问题)
○ 光标跳转设置不好, 鼠标( 光标) 定位错误
● 提示( 可对应于当前BUG体系中的”轻微及建议”)
提示性问题主要为: 易用性及建议性问题
具体基本上可分为:
○ 界面格式等不规范
○ 辅助说明描述不清楚
○ 操作时未给用户提示
○ 可输入区域和只读区域没有明显的区分标志
○ 个别不影响产品理解的错别字
○ 文字排列不整齐等一些小问题
○ 建议
2.3.15.2 Preconditions 前置条件
无
2.3.15.3 End Condition 后置条件
无
2.3.15.4 Actors
系统管理员
2.3.15.5 Trigger 触发条件
该项目已经立项

3 Performance Requirements 性能需求
1. 能够同时让30个用户同时在线操作.
2. 保证系统在6个工作日内运行不能出现异常.
4 Overall Design Constraints 总体设计约束
4.1 Standards compliance 标准符合性
1. Java编码规范:
a) 使用Tab键缩进;
b) 使用驼峰标识;
c) 主要方法和属性要有注释;
d) 属性名小写;
e) 方法名小写;
f) 常量大写.
2. 标准文档模板,格式: 参见所给文档模板.
4.2 Hardware Limitations 硬件约束
要求能运行在内存大于1G的各类PC机器上.
5 Software Quality Attributes 软件质量特性
5.1 Reliability 可靠性
1.强大的及时存储能力,防止数据以外丢失.
2.经测试系统可靠性99.999%.
3.定期对系统进行维护和升级.
5.2 Usability 易用性
1.操作界面友好.
2.系统附带用户手册.
3.提供联机帮助.
6 Requirements Classification 需求分级
Requirement ID
需求ID
Requirement Name
需求名称
Classification
需求分级
Project.Module01.Function01
bug管理
A
Project.Module01.Function01
分配给我的bug
B
Project.Module01.Function01
我创立的bug
C
Project.Module01.Function01
bug查询
A
Project.Module02.Function01
项目管理
A
Project.Module02.Function02
用户组管理
A
Project.Module02.Function03
版本管理
B
Project.Module02.Function04
查询统计
B
Project.Module03.Function01
测试计划管理
A
Project.Module03.Function02
测试用例管理
B
Project.Module03.Function03
用例测试结果管理
B
Project.Module04.Function01
用户管理
A
Project.Module04.Function02
权限管理
A
Project.Module04.Function03
测试类别管理
A
Project.Module04.Function04
bug级别管理
B
表格 2 需求分级表
A. 十分重要
B. 重要
C. 达到需求即可