1 引言
1.1 编写目的
本说明书是客户与软件系统开发者的沟通桥梁.客户根据需求说明书提出需求,阐述系统能做什么.软件系统开发者根据此需求,阐述需求实现的功能与界面,并将之清晰明白的反映到本说明书中,以供客户审阅.
本说明书的预期读者为客户,业务需求分析人员,系统设计人员,项目管理人员,软件开发人员等系统开发的相干参与者.
1.2 项目背景
软件开发过程中无可避免的存在源码缺陷(以下简称BUG).在软件系统的开发维护阶段阶段,对BUG的修复管理工作必不可少.本系统提供了bug的管理功能.客户可应用本系统简单有效的管理BUG,以协助软件系统的开发维护工作.
1.3 定义,缩写词和符号
BUG:软件系统在功能或界面方面所产生的缺陷.
2 系统运行环境
2.1 硬件环境
2.1.1 一台586微机,建议CPU主频在500MHZ以上,内存大于512MB.
2.2 软件环境
2.2.1 WINDOWS 或类 LINUX 操作系统.该操作系统应能正常运行JAVA虚拟机.
2.2.2 安装IE6或FIREFOX1.5浏览器
2.2.3 安装J2SDK,要求版本在1.4以上.
2.2.4 安装TOMCAT或其他支持SERVLET 2.3 的WEB 服务器.
2.2.5 安装MYSQL数据库.要求版本在5.0以上.
3 系统用例说明
3.1 系统用例说明
3.1.1 用例名称:用户查看BUG列表
用例编号:1
用例说明:用户点击"查看我的BUG"标签,查看属于自己的BUG列表.或者点击"查看所有BUG"标签,查看所有BUG列表.并能根据自定 义的条件过滤器,查看符合特定条件的BUG.
前置条件:用户已登录系统.
3.1.2 用例名称:用户查看BUG详情
用例编号:2
用例说明:在BUG列表上存在HTML链接,用户点击该链接,可以看到BUG的详细情况.并且用户可以修改BUG的状态,修改时间.
前置条件:用户已登录系统
3.1.3 用例名称:用户增加新BUG
用例编号:3
用例说明:用户点击"增加新的BUG"界面,进入增加新BUG界面.可以增加新的BUG到系统.
前置条件:用户已登录系统
3.1.4 用例名称:用户管理BUG列表过滤器
用例编号:4
用例说明:用户可以增删改BUG条件过滤器.在BUG列表中,可以通过选取过滤器查看符合特定条件的BUG(请参照用例1).
前置条件:用户已登录系统.
3.1.5 用例名称:用户修改个人资料
用例编号:5
用例说明:用户可以修改个人资料,例如修改EMAIL,住址等.
前置条件:用户已登录系统.
3.1.6 用例名称:用户管理帐号
用例编号:6
用例说明:系统管理员可以增删改新的用户.
前置条件:用户已登录系统,且该用户必须是系统管理员.
3.1.7 用例名称:用户管理开发组
用例编号:7
用例说明:系统管理员可以增删改开发组.在增加新BUG界面,该组名用于划分BUG的归属.
前置条件:用户已登录系统,且该用户必须是系统管理员.
3.2 简单的用例图
见图:
4 系统功能分解
4.1 BUG管理
4.1.1 列出我的BUG
功能简述:以分页的列表方式列出指派给我的bug,可以选择某条记录进行修改,可以弹出框形式查看bug详情.
界面控件:序号Radio(可以选择某条记录),修改按钮(对记录进行修改)
界面标签(指Label):可选项,序号,概述,紧急程度,状态,所有人,发现时间.
HTML链接:序号
4.1.2 查看所有bug
功能简述:以分页的列表方式列出所有bug,可以选择某条记录进行修改,可以弹出框形式查看bug详情.可以按过滤器查看符合该 过滤器条件的bug.
界面控件:序号Radio(可以选择某条记录),修改按钮(对记录进行修改),过滤器选择框(选择某个过滤器).
界面标签(指Label):可选项,序号,概述,紧急程度,状态,所有人,发现时间.
HTML链接:序号
4.1.3 增加新的bug
功能简述:用户可以增加新的bug
界面控件:所属模块选择框(设定bug的所属模块),发现时间日期控件(确定bug的发现时间),发现者选择框(确定bug的发现者),状 态选择框(确定bug的状态),截止期限日期控件(确定bug的建议修改时间),指派给选择框(选择bug的所有人),描述文本域(输入 bug的描述),附件一(文件选择框),附件二(文件选择框),附件三(文件选择框).提交按钮.
界面标签(指Label):根据界面控件描述进行配对.如所属模块选择框的标签是"所属模块".不再赘述.
4.2 个人资料
4.2.1 修改我的资料
功能简述:用户可以更新个人资料
界面控件:姓名文本框(输入姓名),邮箱文本框(输入邮箱),密码文本框(输入文本),确认密码文本框(输入确认密码),所属组别选 择框(输入所属组别),地址文本域(输入地址),备注文本域(输入备注).提交按钮.
界面标签(Label):根据界面控件描述进行配对.如姓名文本框的标签是"姓名".不再赘述.
4.3 过滤器配置
4.3.1 列出过滤器
功能简述:列表方式列出该用户所增加的过滤器,可以选择某条记录进行修改,可以弹出框形式查看过滤器详情,可以删除某条记 录.
界面控件:序号Radio(可以选择某条记录),修改按钮(对记录进行修改),删除按钮(对某条记录进行删除)
界面标签(Label):可选项,序号,过滤器名称.
4.3.2 增加新过滤器
功能简述:用户可以增加新的过滤器.每个用户只能有最多10个过滤器.
界面控件:过滤器名称文本框(输入过滤器名称),状态选择框(选择状态),所属模块选择框(选择模块),发现者选择框(选择发现者 ),指派给选择框(选择bug的所有人),发现时间段时间选择框(选择发现起始时间),发现时间段时间选择框(选择发现终止时间 ),截止时间段时间选择框(选择截止起始时间),截止时间段时间选择框(选择截止终止时间).提交按钮.
界面标签(Label):根据界面控件描述进行配对.如过滤器名称文本框的标签是"过滤器名称".不再赘述.
4.4 系统管理
4.4.1 用户列表
功能简述:列表方式列出所有用户,可以选择某条记录进行修改,可以弹出框形式查看某用户详情,可以删除某条记录.
界面控件:序号Radio(可以选择某条记录),修改按钮(对记录进行修改),删除按钮(对某条记录进行删除)
界面标签(Label):可选项,登录ID,Email,电话,职位
4.4.2 增加新用户
功能简述:增加新用户
界面控件:登录ID文本框(输入用户帐号),姓名文本框(输入姓名),邮箱文本框(输入邮箱),密码文本框(输入文本),确认密码文本 框(输入确认密码),是否管理员选择框(设定是否管理员),地址文本域(输入地址),备注文本域(输入备注).提交按钮.
界面标签(Label):根据界面控件描述进行配对.如姓名文本框的标签是"姓名".不再赘述.
4.4.3 开发组列表
功能简述:列表方式列出所有开发组,可以选择某条记录进行修改,可以弹出框形式查看某记录详情,可以删除某条记录.
界面控件:序号Radio(可以选择某条记录),修改按钮(对记录进行修改),删除按钮(对某条记录进行删除)
界面标签(Label):可选项,开发组名称,描述.
4.4.4 增加新开发组
功能简述:增加新开发组.
界面控件:组名称文本框(输入开发组名称),备注文本域(输入备注).提交按钮.
界面标签(Label):组名称,备注.
4.4.5 日志列表
功能简述:分页列出系统日志.用户删除某条记录,可以弹出框形式查看某条记录详情.
界面控件:删除按钮.
界面标签(Label):可选项,日志时间,用户ID,操作概述.