需求規(guī)格說明書_模板.doc

XXX系統(tǒng)需求規(guī)格說明書需求規(guī)格說明書更改記錄日期修改章節(jié)修改類型修改描述修改人版本2011-09-23全部A創(chuàng)建文檔董善飛1.0*修改類型分為 A - ADDED M - MODIFIED D DELETED 機密第 1 頁 共 14 頁2020/1/17XXX系統(tǒng)需求規(guī)格說明書 目 錄一、文檔約定31文檔項目編號32業(yè)務流程圖33用例圖34實體關系圖45屬性說明46狀態(tài)流轉圖47數(shù)據(jù)流圖58需求優(yōu)先級說明59功能編碼610術語和縮略語6二、需求概述71系統(tǒng)目標72用戶類和特征73業(yè)務分析74系統(tǒng)架構75運行環(huán)境76安裝和部署77限制和約束8三、業(yè)務實體描述91編碼規(guī)則92子系統(tǒng)名稱93數(shù)據(jù)字典9四、功能性需求101XX 子系統(tǒng)101.1XX模塊10五、非功能性需求131易用性132穩(wěn)定性133性能134安全性135可擴展性136可維護性137用戶文檔138質量要求13六、附錄14一、 文檔約定為使預期讀者能夠順利、準確理解本文檔內容，在此對文檔中的“特殊語言”加以約定，即本文檔中使用的格式、符號等內容在此做統(tǒng)一標準，以使本文讀者能夠在共同語言的基礎上理解本文檔內容。1 文檔項目編號此需求規(guī)格說明文檔以“一、1、1.1、1.1.1 ”項目編號形式編排，依次表示“大標題”、“次標題”、“子條目”優(yōu)先級。2 業(yè)務流程圖本文檔中的業(yè)務流程圖中，所應用圖形含義約定如下：項目說明圖例過程業(yè)務處理的操作預定義過程包含細化過程的業(yè)務操作判斷對過程執(zhí)行條件的判斷操作開始某一個業(yè)務過程起始的標識結束某一個業(yè)務過程完成的標識標注對某項目進一步解釋說明的標識3 用例圖本文檔中的用例（UC）圖中，所應用圖形含義約定如下：項目說明圖例參與者在圖形下方標明參與者名稱，可以是系統(tǒng)內的用戶類，也可以是外部系統(tǒng)用例在圖形下方標明動作關聯(lián)用來連接參與者與用例包含用來連接用例，箭頭指向的是被包含的用例擴展用來連接用例，箭頭由擴展用例指向基用例泛化用來連接用例與用例，參與者與參與者，由子指向父4 實體關系圖本文檔中的實體關系（ER）圖中，所應用圖形含義約定如下：項目說明圖例實體矩形框內寫明業(yè)務實體名稱屬性橢圓框內寫明屬性名稱，多值屬性用雙線與實體連接，主屬性名稱下加下劃線聯(lián)系菱形框內寫明聯(lián)系名，并用無向邊分別與有關實體連接起來，同時在無向邊旁標上聯(lián)系的類型，聯(lián)系類型包括1：1（一對一）、1：N（一對多）、N：M（多對多）5 屬性說明本文檔中業(yè)務實體的屬性清單中，各列表項的含義約定如下： 名稱：屬性的中文顯示名稱； 輸入方式：A表示手工輸入、B表示下拉單選、Bn表示列表多選、C表示單項選擇其他實體、Cn表示多項選擇其他實體、D表示系統(tǒng)自動生成，允許屬性有多種輸入方式； 是否必填：Y表示必填、N表示非必填，默認非必填； 備注：其它需要說明事項，例如：屬性的長度限制、特殊格式要求、輸入方式的特殊要求（如與其它屬性的聯(lián)動等）、校驗提示說明、默認值；需要特別聲明的是，這里的業(yè)務屬性說明只是從需求的角度闡述完成業(yè)務操作的必要前提，絕不代表數(shù)據(jù)庫設計，離數(shù)據(jù)庫設計還有很大的差異，但會是將來數(shù)據(jù)庫設計的很好依據(jù)。6 狀態(tài)流轉圖本文檔中的狀態(tài)流轉(STD)圖中，所應用圖形含義約定如下：項目說明圖例初始狀態(tài)一張圖中只能有一個初始狀態(tài)最終狀態(tài)一張圖中可以有一個或多個最終狀態(tài)狀態(tài)圓角矩形框內標明狀態(tài)名稱遷移在有向線上方的“事件”中標明導致狀態(tài)發(fā)生遷移的事件，“條件”標明狀態(tài)的分支，“動作”表明在事件中需執(zhí)行的動作7 數(shù)據(jù)流圖本文檔中的數(shù)據(jù)流(DFD)圖中，所應用圖形含義約定如下：項目說明圖例外部實體方框內標明外部實體名稱，外部實體可以是用戶類，也可以是外部系統(tǒng)處理圓內標明數(shù)據(jù)流的邏輯處理過程數(shù)據(jù)存儲在雙線間標明數(shù)據(jù)存放的地方數(shù)據(jù)流在線段上方標明傳遞的數(shù)據(jù)內容8 需求優(yōu)先級說明優(yōu)先級別重要程度說明R最優(yōu)先必須實現(xiàn)。本文中未做特別表明的需求，優(yōu)先級均默認為優(yōu)先級1。P優(yōu)先爭取實現(xiàn)，如困難，可以變通方式實現(xiàn)M中等爭取實現(xiàn)，如困難，可以變通方式實現(xiàn)；如實在困難，受各種客觀軟硬件條件影響，可以考慮到再升級時實現(xiàn)D可以等待爭取實現(xiàn)，如困難，可以變通方式實現(xiàn)，且不對該功能實現(xiàn)做時間上的要求；如實在困難，可考慮再升級時實現(xiàn)N不太必要再升級時實現(xiàn)9 功能編碼子系統(tǒng)簡稱-編號-需求優(yōu)先級-功能名稱 子系統(tǒng)簡稱：使用三到四個字母縮寫標明功能所屬的子系統(tǒng) 編號：每個子系統(tǒng)從1開始編號 需求優(yōu)先級：使用R、P、M、D、N，具體含義參見“需求優(yōu)先級說明” 功能名稱：使用能夠直觀表達含義的單個完整英文單詞或簡單的英文詞組10 術語和縮略語【】：二、 需求概述1 系統(tǒng)目標使用頂層DFD(數(shù)據(jù)流)圖和簡要文字描述系統(tǒng)范圍及邊界2 用戶類和特征在下表中使用文字描述,也可以使用若干張USECASE圖表示系統(tǒng)最終用戶的類別及主要的業(yè)務應用用戶類主要業(yè)務應用3 業(yè)務分析使用整體職能流程圖描述系統(tǒng)整體業(yè)務 4 系統(tǒng)架構用需求分析人員自己熟悉的架構圖結合文字描述系統(tǒng)的邏輯層次及各層功能構成，小規(guī)模項目可省略 5 運行環(huán)境使用清單描述系統(tǒng)的服務端和客戶端的軟件平臺的一般要求，也可以使用UML中的構件圖來說明6 安裝和部署使用文字描述系統(tǒng)運行必須的軟件平臺安裝步驟，如果有歷史系統(tǒng)，需要描述切換策略和歷史數(shù)據(jù)遷移的范圍，如果有基礎數(shù)據(jù)需要初始化，需要在此處描述初始化的具體內容及可能采用的方式,也可以使用部署圖表示系統(tǒng)的軟硬件整體結構7 限制和約束記錄系統(tǒng)全局性的要求，例如備注字段的長度、日期的顯示格式、金額字段的顯示樣式，,如果在功能性需求中無特殊說明，則業(yè)務實體描述中的實體屬性清單中的屬性出現(xiàn)的順序，即為呈現(xiàn)給最終用戶的順序.三、 業(yè)務實體描述此處使用全局實體關系圖描述系統(tǒng)主要業(yè)務實體之間的邏輯關系1 編碼規(guī)則主要業(yè)務實體的業(yè)務唯一性編號生成規(guī)則說明,如果沒有可以省略本節(jié)2 子系統(tǒng)名稱使用ER圖描述子系統(tǒng)內的各業(yè)務實體靜態(tài)關系，使用下表分別列出模塊內各業(yè)務實體的屬性清單業(yè)務實體名名稱輸入方式必填項備注3 數(shù)據(jù)字典名稱可選項備注四、 功能性需求使用樹形的功能體系圖描述功能分布，基本上這就是系統(tǒng)的菜單導航和功能權限樹, 需定義各子系統(tǒng)簡稱,，以便功能需求編碼,建議使用功能流程圖補充說明系統(tǒng)關鍵路徑，以便項目經理能夠根據(jù)關鍵路徑合理分配資源1 XX 子系統(tǒng)使用細化的職能流程圖說明子系統(tǒng)支持的業(yè)務應用, 使用STD(狀態(tài)流轉)圖描述子系統(tǒng)內關鍵業(yè)務單據(jù)的狀態(tài)流轉1.1 XX模塊使用下表作為功能需求說明的具體模板，事務類業(yè)務操作和統(tǒng)計類操作的使用不同的模板,如果業(yè)務需求文檔已經編號，則兩個模板中都要增加屬性：【業(yè)務需求編號】，考慮是否在模板中增加【需求確認人】1.1.1 CRUD類功能需求模板【功能編碼】【功能描述】描述功能應用的業(yè)務場景【用戶角色】與“需求概述”中的用戶類對應【輸入描述】描述輸入數(shù)據(jù)流，細化到所有的屬性的布局，輸入的校驗,如果無特殊要求，可直接標明來源于哪個業(yè)務實體即可【處理流程】使用DFD（數(shù)據(jù)流）圖說明處理過程，必要時可使用判定樹/表等方式補充說明【輸出描述】描述輸出數(shù)據(jù)流及可能存在的后續(xù)處理操作【約束條件】不同于需求概述中“限制和約束”的特殊前置條件或后續(xù)結果1.1.2 LIST類功能需求模板【功能編碼】【功能描述】描述功能應用的業(yè)務場景【用戶角色】與“需求概述”中的用戶類對應【輸入描述】條件名稱是否必填輸入方式選擇方式可否多選是否默認全部是否模糊默任值對應輸出列備注說明：是否必填，可否多選，是否默認全部，是否模糊：是、否默認值：無默認值的留空輸入方式：手工、選擇、oth選擇方式：下拉、日歷、樹狀注意應在上表下方說明條件之間的與或關系 【輸出結果樣式】結果表頭（即是否回顯輸入）結果標題列結果內容列說明：注意小計、總計行如果有需求，必須在樣式里畫出來，包括輸出內容在列中的對齊方式輸出結果的使用方式是直接在頁面內顯示，還是可下載結果、下載結果中是否帶樣式，是否翻頁，是否顯示總記錄數(shù)都要在這里說明，普遍性約束可在“需求概述”的限制和約束中說明【結果排序說明】標題列名稱順序排序方式說明：順序從開始編號排序方式：升序、降序【內容列詳細說明】標題列名稱數(shù)據(jù)來源計算公式樣式說明小數(shù)位數(shù)值精度千位分隔符單位備注說明：樣式說明：文本、整數(shù)、小數(shù)、百分數(shù)、日期(精確到日、精確到秒毫秒)小數(shù)位：如果輸出內容主體是小數(shù)，小數(shù)點后保留幾位，輸入要保留的位數(shù)數(shù)值精度：未保留的小數(shù)部分是四舍五入、直接取整還是其它的處理方式千位分隔符：輸出內容主體如果是數(shù)字，是否使用千位分隔符，填是或否單位：輸出內容對應的單位，直接手工填寫【約束條件】輸入與輸出是否受權限控制，具體的控制要求是什么【驗證規(guī)則】與哪個參照系統(tǒng)對比，驗證使用的條件和結果說明五、 非功能性需求1 易用性文字描述整體界面風格及操作模式，必要時使用圖片補充說明,下述內容可作為獲取易用性需求的參考1 CRUD中的D類功能中是否要進行確認2 CRUD中的CU類功能是執(zhí)行前集中校驗還是即時校驗輸入屬性值的合法性32 穩(wěn)定性平均無故障運行時間等指標要求3 性能頁面平均/最大響應時間等，注意需要描述應用環(huán)境（服務器軟硬件