1 引言
1.1 編寫目的
本說明書是客戶與軟件系統(tǒng)開發(fā)者的溝通橋梁.客戶根據(jù)需求說明書提出需求,闡述系統(tǒng)能做什么.軟件系統(tǒng)開發(fā)者根據(jù)此需求,闡述需求實(shí)現(xiàn)的功能與界面,并將之清晰明白的反映到本說明書中,以供客戶審閱.
本說明書的預(yù)期讀者為客戶,業(yè)務(wù)需求分析人員,系統(tǒng)設(shè)計(jì)人員,項(xiàng)目管理人員,軟件開發(fā)人員等系統(tǒng)開發(fā)的相干參與者.
1.2 項(xiàng)目背景
軟件開發(fā)過程中無可避免的存在源碼缺陷(以下簡(jiǎn)稱BUG).在軟件系統(tǒng)的開發(fā)維護(hù)階段階段,對(duì)BUG的修復(fù)管理工作必不可少.本系統(tǒng)提供了bug的管理功能.客戶可應(yīng)用本系統(tǒng)簡(jiǎn)單有效的管理BUG,以協(xié)助軟件系統(tǒng)的開發(fā)維護(hù)工作.
1.3 定義,縮寫詞和符號(hào)
BUG:軟件系統(tǒng)在功能或界面方面所產(chǎn)生的缺陷.
2 系統(tǒng)運(yùn)行環(huán)境
2.1 硬件環(huán)境
2.1.1 一臺(tái)586微機(jī),建議CPU主頻在500MHZ以上,內(nèi)存大于512MB.
2.2 軟件環(huán)境
2.2.1 WINDOWS 或類 LINUX 操作系統(tǒng).該操作系統(tǒng)應(yīng)能正常運(yùn)行JAVA虛擬機(jī).
2.2.2 安裝IE6或FIREFOX1.5瀏覽器
2.2.3 安裝J2SDK,要求版本在1.4以上.
2.2.4 安裝TOMCAT或其他支持SERVLET 2.3 的WEB 服務(wù)器.
2.2.5 安裝MYSQL數(shù)據(jù)庫(kù).要求版本在5.0以上.
3 系統(tǒng)用例說明
3.1 系統(tǒng)用例說明
3.1.1 用例名稱:用戶查看BUG列表
用例編號(hào):1
用例說明:用戶點(diǎn)擊"查看我的BUG"標(biāo)簽,查看屬于自己的BUG列表.或者點(diǎn)擊"查看所有BUG"標(biāo)簽,查看所有BUG列表.并能根據(jù)自定 義的條件過濾器,查看符合特定條件的BUG.
前置條件:用戶已登錄系統(tǒng).
3.1.2 用例名稱:用戶查看BUG詳情
用例編號(hào):2
用例說明:在BUG列表上存在HTML鏈接,用戶點(diǎn)擊該鏈接,可以看到BUG的詳細(xì)情況.并且用戶可以修改BUG的狀態(tài),修改時(shí)間.
前置條件:用戶已登錄系統(tǒng)
3.1.3 用例名稱:用戶增加新BUG
用例編號(hào):3
用例說明:用戶點(diǎn)擊"增加新的BUG"界面,進(jìn)入增加新BUG界面.可以增加新的BUG到系統(tǒng).
前置條件:用戶已登錄系統(tǒng)
3.1.4 用例名稱:用戶管理BUG列表過濾器
用例編號(hào):4
用例說明:用戶可以增刪改BUG條件過濾器.在BUG列表中,可以通過選取過濾器查看符合特定條件的BUG(請(qǐng)參照用例1).
前置條件:用戶已登錄系統(tǒng).
3.1.5 用例名稱:用戶修改個(gè)人資料
用例編號(hào):5
用例說明:用戶可以修改個(gè)人資料,例如修改EMAIL,住址等.
前置條件:用戶已登錄系統(tǒng).
3.1.6 用例名稱:用戶管理帳號(hào)
用例編號(hào):6
用例說明:系統(tǒng)管理員可以增刪改新的用戶.
前置條件:用戶已登錄系統(tǒng),且該用戶必須是系統(tǒng)管理員.
3.1.7 用例名稱:用戶管理開發(fā)組
用例編號(hào):7
用例說明:系統(tǒng)管理員可以增刪改開發(fā)組.在增加新BUG界面,該組名用于劃分BUG的歸屬.
前置條件:用戶已登錄系統(tǒng),且該用戶必須是系統(tǒng)管理員.
3.2 簡(jiǎn)單的用例圖
見圖:
4 系統(tǒng)功能分解
4.1 BUG管理
4.1.1 列出我的BUG
功能簡(jiǎn)述:以分頁的列表方式列出指派給我的bug,可以選擇某條記錄進(jìn)行修改,可以彈出框形式查看bug詳情.
界面控件:序號(hào)Radio(可以選擇某條記錄),修改按鈕(對(duì)記錄進(jìn)行修改)
界面標(biāo)簽(指Label):可選項(xiàng),序號(hào),概述,緊急程度,狀態(tài),所有人,發(fā)現(xiàn)時(shí)間.
HTML鏈接:序號(hào)
4.1.2 查看所有bug
功能簡(jiǎn)述:以分頁的列表方式列出所有bug,可以選擇某條記錄進(jìn)行修改,可以彈出框形式查看bug詳情.可以按過濾器查看符合該 過濾器條件的bug.
界面控件:序號(hào)Radio(可以選擇某條記錄),修改按鈕(對(duì)記錄進(jìn)行修改),過濾器選擇框(選擇某個(gè)過濾器).
界面標(biāo)簽(指Label):可選項(xiàng),序號(hào),概述,緊急程度,狀態(tài),所有人,發(fā)現(xiàn)時(shí)間.
HTML鏈接:序號(hào)
4.1.3 增加新的bug
功能簡(jiǎn)述:用戶可以增加新的bug
界面控件:所屬模塊選擇框(設(shè)定bug的所屬模塊),發(fā)現(xiàn)時(shí)間日期控件(確定bug的發(fā)現(xiàn)時(shí)間),發(fā)現(xiàn)者選擇框(確定bug的發(fā)現(xiàn)者),狀 態(tài)選擇框(確定bug的狀態(tài)),截止期限日期控件(確定bug的建議修改時(shí)間),指派給選擇框(選擇bug的所有人),描述文本域(輸入 bug的描述),附件一(文件選擇框),附件二(文件選擇框),附件三(文件選擇框).提交按鈕.
界面標(biāo)簽(指Label):根據(jù)界面控件描述進(jìn)行配對(duì).如所屬模塊選擇框的標(biāo)簽是"所屬模塊".不再贅述.
4.2 個(gè)人資料
4.2.1 修改我的資料
功能簡(jiǎn)述:用戶可以更新個(gè)人資料
界面控件:姓名文本框(輸入姓名),郵箱文本框(輸入郵箱),密碼文本框(輸入文本),確認(rèn)密碼文本框(輸入確認(rèn)密碼),所屬組別選 擇框(輸入所屬組別),地址文本域(輸入地址),備注文本域(輸入備注).提交按鈕.
界面標(biāo)簽(Label):根據(jù)界面控件描述進(jìn)行配對(duì).如姓名文本框的標(biāo)簽是"姓名".不再贅述.
4.3 過濾器配置
4.3.1 列出過濾器
功能簡(jiǎn)述:列表方式列出該用戶所增加的過濾器,可以選擇某條記錄進(jìn)行修改,可以彈出框形式查看過濾器詳情,可以刪除某條記 錄.
界面控件:序號(hào)Radio(可以選擇某條記錄),修改按鈕(對(duì)記錄進(jìn)行修改),刪除按鈕(對(duì)某條記錄進(jìn)行刪除)
界面標(biāo)簽(Label):可選項(xiàng),序號(hào),過濾器名稱.
4.3.2 增加新過濾器
功能簡(jiǎn)述:用戶可以增加新的過濾器.每個(gè)用戶只能有最多10個(gè)過濾器.
界面控件:過濾器名稱文本框(輸入過濾器名稱),狀態(tài)選擇框(選擇狀態(tài)),所屬模塊選擇框(選擇模塊),發(fā)現(xiàn)者選擇框(選擇發(fā)現(xiàn)者 ),指派給選擇框(選擇bug的所有人),發(fā)現(xiàn)時(shí)間段時(shí)間選擇框(選擇發(fā)現(xiàn)起始時(shí)間),發(fā)現(xiàn)時(shí)間段時(shí)間選擇框(選擇發(fā)現(xiàn)終止時(shí)間 ),截止時(shí)間段時(shí)間選擇框(選擇截止起始時(shí)間),截止時(shí)間段時(shí)間選擇框(選擇截止終止時(shí)間).提交按鈕.
界面標(biāo)簽(Label):根據(jù)界面控件描述進(jìn)行配對(duì).如過濾器名稱文本框的標(biāo)簽是"過濾器名稱".不再贅述.
4.4 系統(tǒng)管理
4.4.1 用戶列表
功能簡(jiǎn)述:列表方式列出所有用戶,可以選擇某條記錄進(jìn)行修改,可以彈出框形式查看某用戶詳情,可以刪除某條記錄.
界面控件:序號(hào)Radio(可以選擇某條記錄),修改按鈕(對(duì)記錄進(jìn)行修改),刪除按鈕(對(duì)某條記錄進(jìn)行刪除)
界面標(biāo)簽(Label):可選項(xiàng),登錄ID,Email,電話,職位
4.4.2 增加新用戶
功能簡(jiǎn)述:增加新用戶
界面控件:登錄ID文本框(輸入用戶帳號(hào)),姓名文本框(輸入姓名),郵箱文本框(輸入郵箱),密碼文本框(輸入文本),確認(rèn)密碼文本 框(輸入確認(rèn)密碼),是否管理員選擇框(設(shè)定是否管理員),地址文本域(輸入地址),備注文本域(輸入備注).提交按鈕.
界面標(biāo)簽(Label):根據(jù)界面控件描述進(jìn)行配對(duì).如姓名文本框的標(biāo)簽是"姓名".不再贅述.
4.4.3 開發(fā)組列表
功能簡(jiǎn)述:列表方式列出所有開發(fā)組,可以選擇某條記錄進(jìn)行修改,可以彈出框形式查看某記錄詳情,可以刪除某條記錄.
界面控件:序號(hào)Radio(可以選擇某條記錄),修改按鈕(對(duì)記錄進(jìn)行修改),刪除按鈕(對(duì)某條記錄進(jìn)行刪除)
界面標(biāo)簽(Label):可選項(xiàng),開發(fā)組名稱,描述.
4.4.4 增加新開發(fā)組
功能簡(jiǎn)述:增加新開發(fā)組.
界面控件:組名稱文本框(輸入開發(fā)組名稱),備注文本域(輸入備注).提交按鈕.
界面標(biāo)簽(Label):組名稱,備注.
4.4.5 日志列表
功能簡(jiǎn)述:分頁列出系統(tǒng)日志.用戶刪除某條記錄,可以彈出框形式查看某條記錄詳情.
界面控件:刪除按鈕.
界面標(biāo)簽(Label):可選項(xiàng),日志時(shí)間,用戶ID,操作概述.