4.4.3 功能需求項的編寫示例
上節軟件需求規格書模板中,章節3是大頭,其中涉及功能需求項的編寫。使用Use Case方式進行描述。本節給出一個需求項編寫示例,詳細說明一下編寫方法。前端
使用Use Case方式描述需求,除了正常過程外,還有可選過程和異常過程,還能夠附加一些非功能需求,有助於將需求描述的更完整。後端
下文示例的章節編排按照SRS文檔的章節。spa
章節3.一、SF1000 用戶管理接口
需求描述:系統必須提供用戶帳號管理的功能,包括:APP用戶帳號管理、管理後臺用戶帳號管理。文檔
優先級:5驗證碼
參與者/角色(用戶): 模板
前置條件:class
後置條件:登錄
正常過程:後臺
可選過程:
異常過程:
非功能需求:
注:本節爲非原子級需求項,僅提供需求描述和優先級信息,其它部分在子章節給出。
章節3.1.一、SF1100 APP用戶帳號管理
需求描述:系統必須提供APP用戶帳號管理的功能,包括:APP用戶註冊、APP用戶登陸、APP用戶登出、APP用戶忘記密碼、APP用戶信息維護等功能。
優先級:5
參與者/角色(用戶): APP用戶
前置條件:
後置條件:
正常過程:
可選過程:
異常過程:
非功能需求:
NF0010 在公司任意一款APP註冊了帳號,該帳號能夠用在公司其它的APP,無需從新註冊。
章節3.1.1.一、SF1110 APP用戶註冊
需求描述:系統必須提供APP用戶註冊的功能,註冊包括:手機號註冊、Email郵箱地址註冊。
優先級:5
參與者/角色(用戶): APP用戶
前置條件:
C1 用戶點擊「註冊」,進入註冊頁面
後置條件:
正常過程:
N1 APP用戶註冊
N0010 顯示「手機號註冊」和「Email郵箱註冊」兩個tab頁面
N0020 用戶選擇「手機號註冊」頁面
N0030 進入手機號註冊過程
N0100 正常過程結束
可選過程:
A1 用戶使用「Email郵箱註冊」(N1.N0020的分支)
A0010 用戶選擇「Email郵箱註冊」頁面
A0020 進入Email郵箱地址註冊過程
A0100 返回N1.N0100
異常過程:
非功能需求:
章節3.1.1.1.一、SF1111 APP用戶手機號註冊
需求描述:系統必須提供APP用戶使用手機號註冊的功能,此時手機號爲用戶帳號的登陸名。
優先級:5
參與者/角色(用戶): APP用戶
前置條件:
C1 用戶進入手機號註冊頁面
後置條件:
正常過程:
N1 手機號註冊
N0010 用戶輸入手機號,輸入欄提示顯示「輸入11位國內手機號碼」
N0020 前端驗證手機號的合法性
N0030 手機號合法,驗證碼輸入欄提示顯示「點擊獲取驗證碼」,「獲取驗證碼」按鈕可用
N0040 點擊「獲取驗證碼」按鈕
N0045 點擊後,前端控制「獲取驗證碼」按鈕失效,60秒後恢復使用
N0050 驗證碼輸入欄提示顯示「輸入短信中的驗證碼,60秒內有效」
N0060 用戶輸入驗證碼
N0070 用戶輸入密碼,密碼輸入欄提示顯示「要求不低於6個字符,英文字母或數字」,容許切換明文/密文顯示模式
N0080 用戶確認密碼,容許切換明文/密文顯示模式
N0090 用戶確認無誤後,按「註冊」按鈕
N0100 註冊成功,提示「您已成功註冊,歡迎開啓XXX之旅!」
N0200 正常過程結束
可選過程:
A1 用戶放棄註冊,退出註冊過程(N1的分支)
A0010 用戶點擊「取消」按鈕
A0020 退出註冊過程
A0030 可選過程結束
A2 用戶放棄手機註冊,選擇郵箱註冊過程(N1的分支)
A0010 用戶選擇「Email郵箱註冊」頁面
A0020 返回SF1110.A1.A0020
異常過程:
E1 手機號不合法:長度不合法(N1.N0030的分支)
E0010 提示:手機號長度不是11位
E0020 返回N1.N0010
E2 手機號不合法:號段不合法(N1.N0030的分支)
E0010 提示:不支持XXX號段的手機號(截取前3位數字)
E0020 返回N1.N0010
E3 用戶快速連續點擊「獲取驗證碼」(N1.N0040的分支)
E0010 後端針對此狀況,有相應處理機制,同一手機號,60秒內只容許處理一次獲取驗證碼的請求(同時也防止經過HTTP接口的調用攻擊)
E0020 返回N1.N0045
E4 密碼規則不合法(N1.N0070的分支)
E0010 提示:密碼很多於6位,英文字母或數字
E0020 返回N1.N0070
E5 密碼確認不一致(N1.N0090的分支)
E0010 提示:兩次密碼不一致
E0020 返回N1.N0080
E6 用戶在驗證碼有效期內沒有完成註冊操做(N1.N0090的分支)
E0010 提示:驗證碼錯誤,請從新獲取;如未收到驗證碼短信,請覈查手機號
E0020 清除驗證碼輸入信息,保留其它的輸入信息,返回N1.N0040
E7 手機號已註冊(N1.N0090的分支)
E0010 提示:此手機號已被註冊,無需再註冊
E0020 返回N1.N0010
非功能需求:
NF0010 僅支持中國大陸地區的移動運營商的手機號,11位數字
NF0020 170號段,歸於虛擬運營商,目前不支持此號段手機號註冊;系統應支持號段擴展和調整的靈活性
NF0030 60秒的時間能夠視須要調整
NF0040 針對用戶換號的狀況,系統應提供相應的解決方案
注:後續章節略,僅提供目錄結構和需求編號的示例。
章節3.1.1.1.二、SF1115 APP用戶EMail郵箱地址註冊
章節3.1.1.二、SF1120 APP用戶登陸
章節3.1.1.2.一、SF1121 APP用戶手機號登陸
章節3.1.1.2.二、SF1125 APP用戶EMail郵箱地址登陸
......
章節3.1.二、SF1200 管理後臺用戶帳號管理
......
章節3.二、SF2000 權限管理
......