需求文檔編寫培訓-朱哥出品必出精品

1、需求文檔編寫目錄 需求文檔簡介 文檔模板 范例詳解 引言 產(chǎn)品介紹 產(chǎn)品功能說明 非功能性需求需求文檔簡介 設計人員 交互、UI人員根據(jù)需求文檔設計交互及界面。 研發(fā)人員 根據(jù)文檔進行編碼 測試人員 根據(jù)文檔進行黑盒測試閱讀對象需求文檔簡介需求種類需求種類界面需求功能需求性能需求接口需求報表需求文檔模板范例詳解 標題XXX項目需求規(guī)格說明書 修訂記錄記錄每次修改的內(nèi)容、原因，可供備查。例：序號序號完成日期完成日期修改內(nèi)容修改內(nèi)容作者作者審查審查1 12009-9-17創(chuàng)建文檔XXX 2 22009-12-5添加了無盤服務器負載均衡、回寫熱備兩個用例場景的描述XXX 3 32010-1-5客戶機

2、列表和服務器列表中將IP地址列修改為必顯示列XXX 標題及修訂記錄范例詳解 文檔目的描述文檔的內(nèi)容、給什么人看可copy下面這段話。例：定義XXX項目的需求說明，收集、分析、定義用戶需要和產(chǎn)品特征，詳細描述系統(tǒng)功能性、非功能性、約束等需求。以供研發(fā)、UI交互設計、質(zhì)量保證等人員閱讀。 術語與縮寫解釋文檔里涉及到的一些名詞、縮寫、術語的解釋。注意，自己能理解的，不代表別人能理解！例：縮寫、術語縮寫、術語解釋解釋應用應用應用指云?？蛻舳撕笈_配置的所有資源的統(tǒng)稱。控制臺控制臺指網(wǎng)維大師軟件的服務端操控界面。通常安裝在網(wǎng)吧服務器，也可以安裝在其它機器上遠程連接網(wǎng)吧服務器。引言（一）范例詳解 參考資料羅

3、列本文檔所引用的有關參考文獻名稱、作者、標題、編號、發(fā)布日期和出版單位等基本信息。 文檔中標識對描述習慣、符號等的定義。例：術語、縮寫術語、縮寫解釋解釋優(yōu)先級優(yōu)先級功能說明中的“優(yōu)先級”：H-必需實現(xiàn)，M-應該實現(xiàn)，L-可選實現(xiàn)，L又包括(L1L2L3)|表示可能的取值。如：客戶機狀態(tài)=全部|在線|離線|超管|禁用，表示客戶機可能有5種狀態(tài)：全部|在線|離線|超管|禁用。引言（二）范例詳解描述產(chǎn)品的背景、目的、產(chǎn)品涉及的用戶、產(chǎn)品應該遵循的標準規(guī)范、產(chǎn)品范圍、外部系統(tǒng)接口，等。例如： 背景例：無盤網(wǎng)吧可以統(tǒng)一管理、節(jié)省投資，但維護復雜，對維護人員技術要求高。市面上無盤廠商也在做游戲更新產(chǎn)品，將

4、威脅到順網(wǎng)業(yè)務。 目標例：簡化無盤管理維護工作。降低順網(wǎng)加盟商反水概率，進軍無盤市場，提升網(wǎng)維大師市場占有率。產(chǎn)品介紹（一）范例詳解 產(chǎn)品中的角色與系統(tǒng)發(fā)生交互作用的、系統(tǒng)之外的任何東西都是角色?？梢允侨耍部梢允菣C器每個角色都通過不同的方式使用系統(tǒng)；或者被系統(tǒng)調(diào)用（使用），通常是機器或外部系統(tǒng)例：角色名稱角色名稱職責描述職責描述網(wǎng)管網(wǎng)管負責網(wǎng)吧中無盤、虛擬盤服務器搭建、客戶機安裝、日常運維管理等方面的工作網(wǎng)民網(wǎng)民使用無盤客戶機、虛擬盤來玩游戲或軟件的網(wǎng)吧消費者。產(chǎn)品介紹（二）范例詳解 產(chǎn)品范圍產(chǎn)品范圍指產(chǎn)品或者服務所應該包含的功能，即系統(tǒng)邊界。例1：基于網(wǎng)維大師7160版本，對客戶端界面進行

5、優(yōu)化、增加個性化桌面功能。例2：本期范圍僅限于在無盤二期基礎上所做的調(diào)整、完善部分。主要包括無盤、虛擬控制臺的整合，網(wǎng)維大師客戶端針對無盤模式的調(diào)整，虛擬盤針對無盤模式的調(diào)整，無盤、虛擬盤的業(yè)務控制等方面。例3：產(chǎn)品介紹（三）范例詳解 外部系統(tǒng)接口1、用戶界面 如：界面標準、產(chǎn)品風格、菜單布局，等?？梢栽诮换シ桨钢卸x。例：符合Microsoft的GUI標準。界面支持只通過鍵盤操作（TAB選擇控件、上下箭頭可選擇條目、回車可確定）2、硬件接口例：剩余金額查詢及費用繳納支持從IC卡讀卡器獲?。ń佑|式IC卡，遵循ISO7816接口標準）。3、通信接口 如：電子郵件、WEB瀏覽器、網(wǎng)絡通信協(xié)議，等。

6、例：運營人員審核申請業(yè)務通過，將向加盟商發(fā)送電子郵件，以確認所購買的網(wǎng)吧天數(shù)量。4、軟件接口例：客戶端系統(tǒng)從廣告后臺獲取廣告策略，從IDC獲取廣告資源，實現(xiàn)廣告展示。注意：外部系統(tǒng)接口中的內(nèi)容須在功能中體現(xiàn)。產(chǎn)品介紹（四）范例詳解產(chǎn)品功能說明功能模塊功能模塊菜單名稱菜單名稱需求類型需求類型優(yōu)先級優(yōu)先級功能說明功能說明監(jiān)控中監(jiān)控中心心找回密碼新增H用戶忘記密碼可以通過手機、郵箱找回。網(wǎng)吧監(jiān)控新增L1按網(wǎng)吧查看各網(wǎng)吧客戶機的異常數(shù)據(jù)桌面設置桌面設置 桌面圖標修改L2增加了桌面圖標的類型可自定義文件夾快捷方式。原因：80%的用戶需要定義網(wǎng)吧影院、點餐系統(tǒng)的圖標，目前他們都是使用第三方工具配置這些圖標

7、，極不方便。桌面壁紙修改M增加按分組設置壁紙。系統(tǒng)設置系統(tǒng)設置IE瀏覽記錄查詢刪除H此功能原本是用于網(wǎng)監(jiān)檢查時查詢記錄用，但現(xiàn)在網(wǎng)監(jiān)要求統(tǒng)一安裝單獨的IE記錄監(jiān)測工具，該功能不再使用，故刪除。建議做一張表，列明針對現(xiàn)有版本，需要新增、修改、刪除的功能。除功能描述外，還可以描說明一下增加或修改某項功能的理由、數(shù)據(jù)支撐。如果刪除某項功能，必須寫明原因。范例詳解產(chǎn)品功能說明 針對功能說明表中的功能，一個個地按照模板寫出來（模板見下頁） 交互四步曲：請求、驗證、改變、回應操作人XXX系統(tǒng)XXX操作人XXX系統(tǒng)XXX 使用主動語句，主語是操作人或系統(tǒng) 必須是可理解、可驗證的范例詳解功能描述模板范例詳解功

8、能描述前置條件、后置條件 前置條件：用例開始前，系統(tǒng)需要滿足的約束 后置條件：用例結(jié)束后，系統(tǒng)應具備的狀態(tài) 必須是系統(tǒng)能檢測到的關鍵詞：時間點關鍵詞：時間點 系統(tǒng)系統(tǒng) 約束約束 檢測檢測范例詳解功能描述前置條件、后置條件系統(tǒng)運行正常維護商已登錄系統(tǒng)維護商擁有導入MAC的權限維護商已在控制臺添加過客戶機IP維護商已從路由器導出MAC地址文件必須符合導入格式功能概述：從TXT文件導入客戶機MAC地址要與系統(tǒng)特點相關少說正確而無用的廢話必須是系統(tǒng)能檢測到的必須是用例開始前的檢測請判斷以下前置條件是否正確：范例：可用IP數(shù)量=原數(shù)量-1。系統(tǒng)已添加一臺客戶機。重啟指定客戶機能以超級終端運行。系統(tǒng)已修改

9、指定客戶機的IP地址。范例詳解功能描述前置條件、后置條件系統(tǒng)記錄導入的MAC地址準則：后置條件是約束，不是動作。要記錄的是結(jié)果。站在系統(tǒng)和測試人員的角度描述，測試人員可以進行黑盒測試。系統(tǒng)已記錄導入的MAC地址范例詳解功能描述功能說明主流程：1、用戶選擇身份，輸入賬號及密碼。2、系統(tǒng)請求身份驗證系統(tǒng)進行身份驗證。3、身份驗證系統(tǒng)驗證身份通過。4、系統(tǒng)獲取當前用戶的權限， 調(diào)用“3.2.1監(jiān)控首頁”用例（參見XXXX）。擴展流程：3a1、身份驗證系統(tǒng)驗證身份不通過，返回錯誤信息。3a2、系統(tǒng)提示登錄失敗。針對每一步，思考：1、否定的情況2、是否有其它分支情況3、會有哪些異常范例詳解功能描述功能說

10、明主流程：1、用戶輸入賬號及密碼。2、系統(tǒng)請求身份驗證系統(tǒng)進行身份驗證。3、身份驗證系統(tǒng)驗證身份通過。4、系統(tǒng)獲取當前用戶的權限， 調(diào)用“3.2.1監(jiān)控首頁”用例（參見XXXX）。擴展流程：3a1、身份驗證系統(tǒng)驗證身份不通過，返回錯誤信息。3a2、系統(tǒng)提示登錄失敗。版本一：版本二：1、用戶輸入賬號及密碼。2、系統(tǒng)請求身份驗證系統(tǒng)進行身份驗證。3、身份驗證系統(tǒng)驗證身份，返回結(jié)果。4、系統(tǒng)根據(jù)返回結(jié)果進行判斷： 1）如果返回驗證通過的信息， 系統(tǒng)獲取當前用戶權限， 調(diào)用“3.2.1監(jiān)控首頁”用例（參見XXXX）。 2）如果返回錯誤信息，系統(tǒng)提示錯誤信息，用例結(jié)束。5、范例詳解功能描述功能說明注意事

11、項！主流程：1、用戶勾選“開啟溫度監(jiān)控”。2、系統(tǒng)將溫度編輯框置為可用。3、用戶輸入CPU溫度、顯卡溫度、主板溫度后，點擊“確定”按鈕。4、系統(tǒng)判斷溫度數(shù)值，如果超出范圍，提示： “數(shù)值超出范圍，請重新輸入”。5、不要涉及不要涉及UIUI界面的描述！界面的描述！范例詳解功能描述功能說明注意事項！系統(tǒng)建立數(shù)據(jù)庫連接，執(zhí)行查詢語句，從“網(wǎng)吧基本信息”表中查詢網(wǎng)吧聯(lián)系人。系統(tǒng)從基礎數(shù)據(jù)表中刪除維護商及網(wǎng)吧對應關系是功能描述，不是研發(fā)設計！是功能描述，不是研發(fā)設計！如果我是作為一個數(shù)據(jù)庫腳本工具來開發(fā)，你可以這樣寫如果需求上強制要求必須這樣實現(xiàn)，這時你可以將我寫在“約束”里范例詳解功能描述功能說明注意

12、事項！4、系統(tǒng)反饋應收總金額5、顧客付款6、收銀員提交付款方式和金額7、系統(tǒng)計算找零金額8、系統(tǒng)反饋找零金額、打印票據(jù)9、收銀員找零不要寫系統(tǒng)無法檢測的事！不要寫系統(tǒng)無法檢測的事！范例詳解功能描述功能說明注意事項！系統(tǒng)從操作員處獲取用戶名和密碼用戶名和密碼被驗證會員查詢商品系統(tǒng)給出狀態(tài)提示信息系統(tǒng)顯示天氣溫度情況系統(tǒng)立即顯示，等，或者，通常使使用主動語句，明確責任用主動語句，明確責任操作員提交用戶名和密碼操作員提交用戶名和密碼系系統(tǒng)驗證用戶名和密碼統(tǒng)驗證用戶名和密碼會員在哪里查詢？會員在哪里查詢？會員提交商品查詢條件，系統(tǒng)根據(jù)查詢條件查詢商品會員提交商品查詢條件，系統(tǒng)根據(jù)查詢條件查詢商品描述不

13、清，研發(fā)沒法做描述不清，研發(fā)沒法做系統(tǒng)提示客戶機狀態(tài)，狀態(tài)系統(tǒng)提示客戶機狀態(tài)，狀態(tài)= =離線離線| |在線在線 系統(tǒng)顯示最近一次收到的氣溫，單位攝氏度系統(tǒng)顯示最近一次收到的氣溫，單位攝氏度無意義的語句無意義的語句范例詳解輸入數(shù)據(jù)項數(shù)據(jù)項類型類型長度及約束長度及約束默認值默認值 是否必輸是否必輸身份類型身份類型單選選項為：維護商、網(wǎng)吧維護商 是賬號賬號文本10個字符空是密碼密碼文本16個字符空是范例詳解輸出范例1：CPU數(shù)值超出范圍，系統(tǒng)提示：請輸入50-100之間的整數(shù)。范例2：密碼驗證失敗，系統(tǒng)提示：密碼錯誤，請重新輸入！范例3：系統(tǒng)顯示服務器列表（通常分析師寫出可能發(fā)生的各種分支，交互文檔中描述提示信息。如果分析師有要突出的重點，可在需分文檔中給出建議文案，很多時候，我們把輸出直接放在功能說明中描述了）描述該功能所有輸出數(shù)據(jù)，例如：返回值的內(nèi)容、界面的響應結(jié)果、輸出結(jié)果的規(guī)則、非法值的處理、出錯信息；范例詳解非功能性需求可度量范例詳解