《需求規(guī)格說明書-范本.doc》由會(huì)員分享,可在線閱讀,更多相關(guān)《需求規(guī)格說明書-范本.doc(12頁珍藏版)》請?jiān)谘b配圖網(wǎng)上搜索。
1、 項(xiàng)目名稱項(xiàng)目名稱 需求規(guī)格說明書需求規(guī)格說明書 建設(shè)單位:建設(shè)單位: 建設(shè)方建設(shè)方 LOGOLOGO 需求規(guī)格說明書 建設(shè)方建設(shè)方 LOGOLOGO 第 1 頁 承建單位:承建單位: 編訂時(shí)間:編訂時(shí)間:YYYY-MM-DDYYYY-MM-DD 文件修訂記錄文件修訂記錄 修訂日期版本修訂內(nèi)容修訂人審核人 建設(shè)方建設(shè)方 LOGOLOGO 需求規(guī)格說明書 建設(shè)方建設(shè)方 LOGOLOGO 第 2 頁 目目 錄錄 第第 1 章章前言前言 .1 1.1目的1 1.2項(xiàng)目概述.1 1.3術(shù)語和縮寫1 1.4參考資料.1 第第 2 章章業(yè)務(wù)需求業(yè)務(wù)需求.1 2.1用戶組織結(jié)構(gòu) 1 2.2業(yè)務(wù)需求概述 2
2、2.3業(yè)務(wù)需求一2 2.4業(yè)務(wù)需求二2 第第 3 章章功能需求功能需求.2 3.1功能需求概述 2 3.2用戶角色.2 3.3公共功能需求 2 3.4模塊一 2 3.5模塊二 4 第第 4 章章用戶界面需求用戶界面需求 4 第第 5 章章系統(tǒng)接口需求系統(tǒng)接口需求 4 5.1接口需求一4 5.2接口需求二5 5.3轉(zhuǎn)換需求.5 第第 6 章章代碼集代碼集5 建設(shè)方建設(shè)方 LOGOLOGO 需求規(guī)格說明書 建設(shè)方建設(shè)方 LOGOLOGO 第 3 頁 6.1代碼一 5 6.2代碼二 5 第第 7 章章系統(tǒng)運(yùn)行環(huán)境系統(tǒng)運(yùn)行環(huán)境 5 7.1軟件環(huán)境.5 7.2硬件環(huán)境.5 7.3網(wǎng)絡(luò)環(huán)境.6 第第 8
3、章章其它需求其它需求.6 8.1性能需求.6 8.2存儲需求.6 8.3易用性需求6 8.4可靠性需求6 8.5可維護(hù)性需求 7 8.6安全需求.7 8.7設(shè)計(jì)約束.7 建設(shè)方建設(shè)方 LOGOLOGO 需求規(guī)格說明書 建設(shè)方建設(shè)方 LOGOLOGO 第 4 頁 第 1 頁 第第 1 章章 前前言言 1.1目的目的 說明開發(fā)本軟件的目的; 說明編寫文檔的目的; 說明本文檔所預(yù)期的讀者 1.2項(xiàng)目概述項(xiàng)目概述 簡述項(xiàng)目背景及目標(biāo): 項(xiàng)目背景: 項(xiàng)目的提出原因 項(xiàng)目環(huán)境背景 項(xiàng)目優(yōu)勢分析(資源、技術(shù)、人才、管理等方面) 項(xiàng)目運(yùn)作的可行性 項(xiàng)目的獨(dú)特與創(chuàng)新分析 1.3術(shù)語術(shù)語和縮寫和縮寫 列出本需求說
4、明書中專門術(shù)語的定義以及英語縮寫詞的原詞組。 1.4參考資料參考資料 列出本項(xiàng)目經(jīng)核準(zhǔn)的任務(wù)書或合同和上級機(jī)關(guān)的批文; 列出編寫本軟件需求說明書時(shí)參考的文件、資料、技術(shù)標(biāo)準(zhǔn)以及它們的作者、標(biāo)題、發(fā)布日期 和出版單位等。 第第 2 章章 業(yè)業(yè)務(wù)務(wù)需需求求 描述客戶組織結(jié)構(gòu)、業(yè)務(wù)處理流程,接口需求、及其他需求。如果編寫了業(yè)務(wù)需求說明書文 檔可在此處引用,不需要編寫本章節(jié)內(nèi)容。 2.1用戶組織結(jié)構(gòu)用戶組織結(jié)構(gòu) 說明業(yè)務(wù)系統(tǒng)所涉及到的用戶部門、崗位、職責(zé),并說明與業(yè)務(wù)系統(tǒng)相關(guān)的用戶特性。用戶特 性一般包含操作人員、維護(hù)人員的教育水平和技術(shù)專長以及本軟件的預(yù)期使用頻度。這些是軟 件設(shè)計(jì)工作的重要約束。
5、例如:二次開發(fā)人員:具有很高的專業(yè)知識水平,理解業(yè)務(wù)系統(tǒng)的運(yùn)行機(jī)制。可以對開放代碼 進(jìn)行閱讀和分析,以完成其系統(tǒng)獨(dú)特的需求,提供給這部分用戶開放 API 手冊和 Debug 版本 的源代碼即可。 一般用戶:具有一定的計(jì)算機(jī)操作能力和知識,了解業(yè)務(wù)領(lǐng)域的相關(guān)概念和用途。提供給這部 第 2 頁 分用戶操作手冊即可。 維護(hù)人員:具有較高的計(jì)算機(jī)專業(yè)水平,可以對常見的系統(tǒng) Bug 進(jìn)行追蹤和分析,具有一定 的測試能力,這部分用戶主要是采用了本系統(tǒng)之后的后期工作維護(hù)者。 2.2業(yè)務(wù)需求業(yè)務(wù)需求概述概述 對業(yè)務(wù)需求從整體上進(jìn)行概述,并說明業(yè)務(wù)邊界。 2.3業(yè)務(wù)需求業(yè)務(wù)需求一一 如果業(yè)務(wù)需求較多,需目錄層次
6、描述。 2.3.1業(yè)務(wù)描述業(yè)務(wù)描述 簡要描述本章節(jié)業(yè)務(wù)需求,如果業(yè)務(wù)流程章節(jié)省略,本章節(jié)須與上一章節(jié)合并。 2.3.2業(yè)務(wù)流程業(yè)務(wù)流程 可選章節(jié),結(jié)合業(yè)務(wù)流程圖對業(yè)務(wù)流程描述和所需的業(yè)務(wù)表單進(jìn)行說明,如果業(yè)務(wù)流程比較簡 單,可以整體描述,如果業(yè)務(wù)流程比較復(fù)雜,須分節(jié)點(diǎn)描述。 2.4業(yè)務(wù)需求二業(yè)務(wù)需求二 第第 3 章章 功功能能需需求求 3.1功能需求概述功能需求概述 對系統(tǒng)功能進(jìn)行概述,畫出系統(tǒng)功能結(jié)構(gòu)圖并對其進(jìn)行說明,注意一定要包含后臺維護(hù)性功能 與統(tǒng)計(jì)性功能的說明。 3.2用戶角色用戶角色 說明與系統(tǒng)使用相關(guān)的所有角色,使用下表列出。 #角色名稱角色說明 3.3公共功能需求公共功能需求 可
7、選章節(jié)。 為了解決重復(fù)描述,將散落在各個(gè)模塊的需求描述抽取出來,統(tǒng)一進(jìn)行描述,包括但不限于分 頁功能、字段校驗(yàn)提示、系統(tǒng)錯(cuò)誤、安全錯(cuò)誤、系統(tǒng)超時(shí)、流程預(yù)警及超時(shí)提醒。 3.4模塊模塊一一 對于較大型系統(tǒng)可以根據(jù)實(shí)際需要按目錄分解子模塊、三四級模塊分層進(jìn)行說明。 第 3 頁 3.4.1功能結(jié)構(gòu)功能結(jié)構(gòu) 使用功能結(jié)構(gòu)表列出本模塊所有功能。 功能名稱涉及角色說明 3.4.2功能功能一一 1.功能描述 對該功能進(jìn)行簡述,并對所涉及的頁面及其導(dǎo)航鏈接關(guān)系進(jìn)行說明。 2.用戶界面 畫出用戶界面圖形,可以使用系統(tǒng)原型界面截圖。 3.用戶界面說明 詳細(xì)描述頁面數(shù)據(jù),可以使用下表進(jìn)行描述: #數(shù)據(jù)名稱類型長度格
8、式必須取值備注 1 注:1) 類型包含單行輸入框、多行輸入框、下拉框、單選框、多選框、列表框、雙向選擇、 按鈕、鏈接、顯示(表示數(shù)據(jù)字段只為查看的內(nèi)容,非編輯字段)顯示編輯(表示數(shù)據(jù)字段作 為可查看內(nèi)容同時(shí)又可編輯); 2) 格式包含字符、日期、數(shù)字等; 3) 必須表示是必填還是可空; 4) 取值表示數(shù)據(jù)的取值范圍,對于代碼類型的數(shù)據(jù),可以引用代碼名稱; 5) 備注中描述其他信息(象按鈕完成的功能等) 4.功能操作說明 輸入 詳細(xì)描述該用戶界面的輸入數(shù)據(jù),如:輸入源、數(shù)量或有效范圍、度量單位、時(shí)間設(shè)定。 業(yè)務(wù)處理 說明該功能的業(yè)務(wù)處理過程,一般包含: 輸入數(shù)據(jù)的有效性檢查; 業(yè)務(wù)操作順序(包括
9、事件的時(shí)間設(shè)定); 異常響應(yīng)處理,例如,溢出、通信故障、錯(cuò)誤處理等; 受操作影響的參數(shù); 輸出數(shù)據(jù)的有效性檢查。 輸出 詳細(xì)描述該功能所有輸出數(shù)據(jù),包含輸出目的地、數(shù)量或有效范圍、度量單位、時(shí)間關(guān)系、出 錯(cuò)信息描述; 第 4 頁 3.4.3功能二功能二 3.4.3.1子功能子功能 3.4.3.1.1子功能子功能 3.4.3.1.1.1 子功能子功能 3.4.3.1.1.1.1 子功能子功能 3.5模塊二模塊二 第第 4 章章 用用戶戶界界面面需需求求 可選章節(jié),如果用戶有明確的界面公共需求則需要在這里通過界面效果截圖進(jìn)行描述。用戶界 面需求通常包含: 用戶界面大體風(fēng)格描述,對屏幕格式的要求,色
10、彩、分辨率等; 屏幕行為(例如進(jìn)入程序后第一界面,焦點(diǎn)默認(rèn)于左上角底一個(gè)按鈕,還是無焦點(diǎn)狀態(tài)); 用戶的交互方法(例如快捷鍵和右鍵菜單); 系統(tǒng)時(shí)間會(huì)應(yīng)用戶的反饋時(shí)間; 各種特色的控件交互; 窗口位置、大??; 軟件導(dǎo)航的數(shù)據(jù)與軟件同步; 錯(cuò)誤的預(yù)防和恢復(fù); 標(biāo)準(zhǔn)色、圖標(biāo)指針的標(biāo)準(zhǔn)應(yīng)用; 報(bào)表或菜單的頁面打印格式和內(nèi)容; 程序功能鍵的可用性; 即時(shí)幫助與提示。 第第 5 章章 系系統(tǒng)統(tǒng)接接口口需需求求 5.1接口需求接口需求一一 5.1.1接口目的接口目的 5.1.2接口方式接口方式與標(biāo)準(zhǔn)與標(biāo)準(zhǔn) 以何種方式提供接口、如何使用接口、接口必須遵守的標(biāo)準(zhǔn)規(guī)范。 5.1.3接口內(nèi)容接口內(nèi)容 接口傳遞的數(shù)
11、據(jù)信息與處理過程描述等。 第 5 頁 5.2接口需求二接口需求二 5.3轉(zhuǎn)換需求轉(zhuǎn)換需求 數(shù)據(jù)轉(zhuǎn)換需求。通常需要把一些歷史數(shù)據(jù)(包含紙質(zhì)的、電子的獨(dú)立文件)導(dǎo)入到開發(fā)的系統(tǒng) 中去。 第第 6 章章 代代碼碼集集 如果代碼內(nèi)容較多,可以在獨(dú)立的文檔中按照以下要求編寫,并將此獨(dú)立文檔作為附件。 6.1代碼一代碼一 說明此代碼名稱,并對代碼的用途或內(nèi)容等進(jìn)行簡述,說明代碼采用的編碼規(guī)則,并說明代碼 集內(nèi)容。代碼集屬性至少包含:編碼、名稱、說明,可以增加其他屬性列(簡稱、縮寫等)。 如果編碼規(guī)則使用國標(biāo)或行標(biāo)等相關(guān)標(biāo)準(zhǔn)規(guī)范,可以在此寫出引用標(biāo)準(zhǔn)規(guī)范名稱,并將被引用 標(biāo)準(zhǔn)規(guī)范作為附件,不再需要填寫下表。
12、 代碼名稱 代碼簡述 編碼規(guī)則 #編碼名稱說明 1 2 3 4 5 6.2代碼二代碼二 第第 7 章章 系系統(tǒng)統(tǒng)運(yùn)運(yùn)行行環(huán)環(huán)境境 說明系統(tǒng)正式運(yùn)行的客戶環(huán)境要求,最好結(jié)合系統(tǒng)部署圖進(jìn)行說明。 7.1軟件環(huán)境軟件環(huán)境 列出支持軟件,包括要用到的操作系統(tǒng)、中間件、數(shù)據(jù)庫等。 7.2硬件環(huán)境硬件環(huán)境 列出運(yùn)行該軟件所需要的硬設(shè)備。說明其中的新型設(shè)備及其專門功能,包括: 處理器型號及內(nèi)存容量; 外存容量、聯(lián)機(jī)或脫機(jī)、媒體及其存儲格式,設(shè)備的型號及數(shù)量; 第 6 頁 數(shù)據(jù)通信設(shè)備的型號和數(shù)量; 其他輸入及輸出設(shè)備的型號和數(shù)量,聯(lián)機(jī)或脫機(jī)。 7.3網(wǎng)絡(luò)環(huán)境網(wǎng)絡(luò)環(huán)境 第第 8 章章 其其它它需需求求 可選章
13、節(jié),根據(jù)業(yè)務(wù)需要選擇涉及到的小節(jié)進(jìn)行描述,如果小節(jié)的內(nèi)容不能涵蓋其他需求,可 以增加小節(jié)進(jìn)行描述,例如擴(kuò)充性,擴(kuò)展性,軟件所有必需的法律免責(zé)聲明、擔(dān)保、版權(quán)聲明、 專利聲明、文字商標(biāo)、商標(biāo)或徽標(biāo)遵從問題等。 8.1性能需求性能需求 描述哪些業(yè)務(wù)操作對性能的具體需求,并解釋產(chǎn)生性能需求的原因以幫助開發(fā)人員作出合理的 設(shè)計(jì)選擇。性能需求通常包含: 并發(fā)用戶數(shù)量(總用戶量及并發(fā)用戶量); 事務(wù)的響應(yīng)時(shí)間(平均值、最大值),通常指在達(dá)到最大并發(fā)用戶時(shí)的響應(yīng)時(shí)間; 吞吐量,例如每秒事務(wù)數(shù) ,通常指在達(dá)到最大并發(fā)用戶時(shí)的吞吐量; 容量;一般指系統(tǒng)能夠容納的用戶或事務(wù)數(shù)量; 8.2存儲需求存儲需求 描述磁盤
14、空間、數(shù)據(jù)庫或存儲器的數(shù)據(jù)容量需求。一般計(jì)算每年的數(shù)據(jù)存儲需求,每年的增長 率等。 8.3易用性需求易用性需求 易用性需求指用戶為使用系統(tǒng)功能所做的努力與使用評價(jià),一般包含易理解、易學(xué)習(xí)、易操作 等方面。 8.4可靠性需求可靠性需求 可靠性需求指系統(tǒng)保持正常運(yùn)行的能力,常用的衡量指標(biāo): 此處應(yīng)指定系統(tǒng)的可靠性需求。建議如下: 可用性 指有效的時(shí)間內(nèi)運(yùn)行比率的正常值(運(yùn)行比率=正常運(yùn)行時(shí)間(正常運(yùn)行時(shí)間+修 復(fù)時(shí)間); 平均故障間隔時(shí)間(MTBF) 通常以小時(shí)為單位指定,但也可以天、月或年為單位指定; 平均修復(fù)時(shí)間(MTTR) 指在系統(tǒng)發(fā)生故障后允許系統(tǒng)中斷時(shí)間; 準(zhǔn)確性 指定在系統(tǒng)輸出中必需的
15、精度(分辨率)和準(zhǔn)確性(按照某些已知的標(biāo)準(zhǔn)); 最大錯(cuò)誤或缺陷率 通常以每千行代碼錯(cuò)誤數(shù)(錯(cuò)誤數(shù)KLOC)或每個(gè)功能點(diǎn)錯(cuò)誤數(shù)(錯(cuò) 誤數(shù)功能點(diǎn))為單位表示。 第 7 頁 8.5可維護(hù)性需求可維護(hù)性需求 可維護(hù)性指維護(hù)系統(tǒng)正常運(yùn)行或修復(fù)問題所做出努力的程度。一般包含日常運(yùn)維、服務(wù)響應(yīng)、 系統(tǒng)升級、系統(tǒng)運(yùn)行監(jiān)控方法與手段、問題定位與分析方法、完整可靠的數(shù)據(jù)備份方案以及相 關(guān)的制度規(guī)范等方面的要求。 8.6安全需求安全需求 安全性需求一般包含: 應(yīng)用安全 數(shù)據(jù)安全 網(wǎng)絡(luò)與系統(tǒng)安全 物理安全 確定系統(tǒng)安全性的要素一般包含: 確定需要保護(hù)的安全對象 確定安全威脅的來源 確定安全威脅的類型 意外的損壞或破壞 故意的損壞或破壞 欺騙行為 黑客行為 病毒/木馬 8.7設(shè)計(jì)約束設(shè)計(jì)約束 說明對于要構(gòu)建系統(tǒng)的所有設(shè)計(jì)約束。設(shè)計(jì)約束是指批準(zhǔn)的必須遵從的設(shè)計(jì)決定,一般包含軟 件語言、軟件流程管理、使用的開發(fā)工具、體系結(jié)構(gòu)和設(shè)計(jì)約束、購買的組件、類庫等。