軟件工程需求分析文檔模板

編號(hào)題目項(xiàng)目類別版本V1.0時(shí)間SAVEDATE\@"yyyy-MM-dd"2010-06-30二〇一〇年六月三十日

版本修訂記錄版本日期描述作者審核

目錄1 引言 31.1 編寫目的 31.2 背景 31.3 術(shù)語定義 31.4 參考資料 32 系統(tǒng)概述 32.1 系統(tǒng)功能框架 32.2 運(yùn)行環(huán)境 32.3 開發(fā)環(huán)境 32.4 用戶特點(diǎn) 32.5 條件與限制 33 功能描述 33.1 功能分解 33.2 各功能描述 34 數(shù)據(jù)描述 35 性能描述 36 接口描述 37 其他要求 38 未盡事宜 3附件 3

引言編寫目的{簡要說明編寫這份需求分析報(bào)告的目的，指出預(yù)期的讀者。本軟件需求分析報(bào)告的編寫目的是為了提供一個(gè)由用戶（或委托者）和開發(fā)者雙方共同確定的開發(fā)系統(tǒng)的業(yè)務(wù)需求目標(biāo)，并對(duì)所實(shí)現(xiàn)的軟件功能做全面的規(guī)格描述。同時(shí)，在用戶業(yè)務(wù)需求的基礎(chǔ)上，經(jīng)過需求分析和數(shù)據(jù)整理，以向整個(gè)開發(fā)期提供關(guān)于軟件系統(tǒng)的業(yè)務(wù)和數(shù)據(jù)的技術(shù)信息和整體描述，成為軟件開發(fā)的技術(shù)基礎(chǔ)，也作為系統(tǒng)設(shè)計(jì)和實(shí)現(xiàn)的目標(biāo)及驗(yàn)收依據(jù)。本軟件需求分析報(bào)告的適用讀者，一般為：軟件客戶、軟件需求分析人員、軟件設(shè)計(jì)及開發(fā)者和相關(guān)的測(cè)試人員}背景{1.說明待開發(fā)的軟件系統(tǒng)的名稱2.列出本項(xiàng)目的任務(wù)委托單位、開發(fā)單位、協(xié)作單位、用戶單位3.說明項(xiàng)目背景，敘述該項(xiàng)軟件開發(fā)的意圖、應(yīng)用目標(biāo)、作用范圍以及其他應(yīng)向讀者說明的有關(guān)該軟件開發(fā)的背景材料。如果本次開發(fā)的軟件系統(tǒng)是一個(gè)更大的系統(tǒng)的一個(gè)組成部分，則要說明該更大系統(tǒng)的組成和介紹本系統(tǒng)與其它相關(guān)系統(tǒng)的關(guān)系和接口部分4.保密說明：本項(xiàng)為可選項(xiàng)，只有當(dāng)用戶強(qiáng)烈要求對(duì)其業(yè)務(wù)內(nèi)容進(jìn)行保密，不允許被復(fù)制、使用和擴(kuò)散到其企業(yè)范圍之外時(shí)，才要對(duì)此項(xiàng)進(jìn)行專門的保密說明5.版權(quán)說明：本項(xiàng)為可選項(xiàng)，若有必要，才要作有關(guān)的描述。}術(shù)語定義{列出本文檔中提供全部需求所用到的專門術(shù)語的定義和首字母縮寫詞、縮略語的原文，以便對(duì)需求分析報(bào)告進(jìn)行適當(dāng)?shù)慕忉寎參考資料{列出所本文檔所使用的參考資料，包括：A本軟件開發(fā)所經(jīng)核準(zhǔn)的合同或標(biāo)書或可行性報(bào)告等文檔B軟件開發(fā)計(jì)劃書C與本項(xiàng)目有關(guān)的已發(fā)表的文件或資料D本文件中各處引用的文件、資料，所采用的軟件開發(fā)標(biāo)準(zhǔn)和規(guī)范注意：必須列出文件、資料的作者、標(biāo)題、編號(hào)、發(fā)表日期和出版單位，以說明這些文件資料的來源。若某些文檔有保密要求的，則要說明其保密級(jí)別。系統(tǒng)概述系統(tǒng)功能框架{主要介紹本軟件系統(tǒng)的總體結(jié)構(gòu)和總體功能劃分，只要求提供影響需求的一般因素以及將要完成的軟件功能摘要，不必說明具體的需求，也不必描寫功能所要求的大量細(xì)節(jié)，本節(jié)主要目的僅僅是使需求更加易于理解：可以從系統(tǒng)功能的層次結(jié)構(gòu)、所應(yīng)用的機(jī)構(gòu)概況(如組織架構(gòu)、業(yè)務(wù)范圍、工作流程等)、所描述的數(shù)據(jù)對(duì)象、所包括的系統(tǒng)功能模塊組合或功能列表等方面進(jìn)行描述}運(yùn)行環(huán)境{說明本軟件系統(tǒng)的運(yùn)行環(huán)境的拓樸結(jié)構(gòu)和布局,應(yīng)包括通訊條件、網(wǎng)絡(luò)環(huán)境、硬件配置、軟件系統(tǒng)等，建議畫出系統(tǒng)運(yùn)行環(huán)境的體系結(jié)構(gòu)圖，說明在網(wǎng)絡(luò)環(huán)境和硬件配置的最低要求下可運(yùn)行的條件，要求說明網(wǎng)絡(luò)的通訊協(xié)議要求和所需要的端口號(hào)、是否需要口令安全及網(wǎng)絡(luò)許可等，羅列運(yùn)行環(huán)境下所需要的支持性軟件及有效版本號(hào)}開發(fā)環(huán)境{為可選項(xiàng)，有必要說明時(shí)才適用。一般情況認(rèn)為，開發(fā)環(huán)境需要某種特定的硬件設(shè)備或某種指定的不常見的開發(fā)工具或者在特定的封閉式的開發(fā)環(huán)境下等特別情況，才認(rèn)為有必要強(qiáng)調(diào)說明開發(fā)環(huán)境。如果屬于正常情況下都能夠達(dá)到的開發(fā)環(huán)境，可以不做特別說明。本軟件系統(tǒng)的開發(fā)環(huán)境，應(yīng)包括軟件的開發(fā)工具、硬件配置、網(wǎng)絡(luò)環(huán)境、軟件平臺(tái)、通訊條件、開發(fā)場(chǎng)所等內(nèi)容。}用戶特點(diǎn){說明使用本軟件系統(tǒng)的用戶的特點(diǎn)，重點(diǎn)可以說說用戶所處的行業(yè)特點(diǎn)。建議從使用本系統(tǒng)的用戶角色上進(jìn)行分類說明，以充分說明操作人員、維護(hù)人員的教育水平、業(yè)務(wù)專長、計(jì)算機(jī)技術(shù)水平。要注意的是，用戶可能會(huì)在技術(shù)方面參差不齊，相差間距比較大，可以認(rèn)為技術(shù)性比較強(qiáng)的用戶可能會(huì)需要復(fù)雜、靈活并具備跨平臺(tái)支持的工具，而計(jì)算機(jī)技術(shù)水平比較弱的入門用戶則會(huì)需要使用方便、界面友好的工具。}條件與限制{為可選項(xiàng)，只要當(dāng)軟件系統(tǒng)的設(shè)計(jì)或開發(fā)受到某種特定的限制，或者影響需求的某種因素，這些因素可能不是軟件的設(shè)計(jì)約束，但是他們的改變可能會(huì)影響某些需求的時(shí)候，要做相關(guān)的系統(tǒng)約束的介紹。若存在以下方面的系統(tǒng)約束或條件限制時(shí)，可以進(jìn)行相關(guān)的闡明：（但不限于這些）為完成本軟件系統(tǒng)應(yīng)具備的特定條件、開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件,如：現(xiàn)階段未完全確定的需求或未到位的設(shè)備或與本系統(tǒng)相關(guān)的未明確的其他業(yè)務(wù)，需要做出相應(yīng)的約束說明必要時(shí)，還應(yīng)說明用戶及分合同承包者承擔(dān)的工作、完成期限及其他條件與限制，如果用戶及分合同承包者對(duì)系統(tǒng)的實(shí)現(xiàn)起到的某些作用會(huì)直接影響系統(tǒng)的成敗則要特別說明本系統(tǒng)的功能實(shí)現(xiàn)需要受到某些特定的行業(yè)規(guī)范的限制本系統(tǒng)的開發(fā)需要受到用戶對(duì)系統(tǒng)的工程化管理的某些特別的要求，包括用戶規(guī)定對(duì)系統(tǒng)實(shí)現(xiàn)的全過程的變更規(guī)定本系統(tǒng)開發(fā)工作所需的一些假定條件和必須滿足的約束，如本功能的開發(fā)假定用戶會(huì)熟練使用SQL語言，本功能的實(shí)現(xiàn)應(yīng)該在某功能實(shí)現(xiàn)前開發(fā)完成等本系統(tǒng)可能需要使用的所有購入構(gòu)件、所有適用的許可或使用限制，以及所有相關(guān)的兼容性及互操作性或接口標(biāo)準(zhǔn)的有關(guān)限制和規(guī)定}功能描述功能分解{可以用業(yè)務(wù)流程圖的方式來說明本系統(tǒng)的軟件業(yè)務(wù)需求，然后再對(duì)業(yè)務(wù)需求進(jìn)行分析后逐步細(xì)化并分層所進(jìn)行的功能分解的情況，可以用功能列表的方式進(jìn)行表示，也可以采用數(shù)據(jù)流圖的方式來描述新系統(tǒng)的邏輯模型圖}各功能描述{標(biāo)題可以根據(jù)功能列表或數(shù)據(jù)流圖中的功能模塊自行決定，建議每一大塊功能為單獨(dú)一節(jié)，建議對(duì)于功能模塊在此時(shí)就要加上有關(guān)標(biāo)識(shí)號(hào)，編碼規(guī)則在不違背公司ISO程序文件《文件編碼和撰寫規(guī)范》的要求自行制訂。詳細(xì)描述系統(tǒng)各個(gè)需求做出相應(yīng)功能的全部細(xì)節(jié)，要求對(duì)每一個(gè)需求只有一種解釋，就是：每一個(gè)需求都是可以驗(yàn)證的，各個(gè)需求的描述是不矛盾，也不冗余的，及同一需求不能在本需求分析報(bào)告中出現(xiàn)多次。主要就是描述軟件產(chǎn)品的輸入如何轉(zhuǎn)化程輸出，即軟件必須完成的基本動(dòng)作。對(duì)于每一類功能或每一個(gè)功能，均需要具體描述其輸入、處理和輸出的需求。需求的功能描述建議參照以下格式進(jìn)行書寫：XXXXXXXX（功能編號(hào)）,XXXXXXXXX(功能名稱)功能該功能的簡述業(yè)務(wù)流程畫出該功能描述的相關(guān)業(yè)務(wù)流程圖，也允許使用數(shù)據(jù)流圖（底層）表示業(yè)務(wù)數(shù)據(jù)流的來源和處理去向輸入羅列輸入數(shù)據(jù)項(xiàng)及其屬性要求（包括數(shù)據(jù)類型、長度等信息），并注明數(shù)據(jù)項(xiàng)輸入的方式。輸入方式主要有三種：手工錄入、根據(jù)下拉框進(jìn)行選擇輸入的、不可輸入域根據(jù)某些已輸入的信息由系統(tǒng)自動(dòng)生成（需要根據(jù)公式自動(dòng)計(jì)算，則要說明具體的計(jì)算公式）。如果該輸入數(shù)據(jù)項(xiàng)為唯一碼或非空域，則要特別說明。界面若存在界面，則需注明參見某圖表或參見某附件必要時(shí)，介紹界面的流轉(zhuǎn)算法詳細(xì)描述該功能的業(yè)務(wù)邏輯及有關(guān)處理說明，包括將輸入轉(zhuǎn)化成有關(guān)的輸出的具體算法輸出羅列輸入數(shù)據(jù)項(xiàng)及其屬性要求（包括數(shù)據(jù)類型、長度等信息），如果輸出格式是某張報(bào)表，則要求描述相應(yīng)的報(bào)表格式，也可以注明參見某個(gè)圖表或某個(gè)附件資料備注輸入，修改內(nèi)容如非特別說明，否則非空本章節(jié)的標(biāo)題可以根據(jù)本軟件系統(tǒng)的相關(guān)功能列表進(jìn)行安排}數(shù)據(jù)描述{收集、整理各種原始數(shù)據(jù)、單據(jù)與報(bào)表，說明其來源或去處，詳細(xì)說明每張?jiān)紨?shù)據(jù)報(bào)表中各個(gè)數(shù)據(jù)項(xiàng)的要求，包括：數(shù)據(jù)類型、寬度、數(shù)值范圍，必要時(shí)還可以說明數(shù)據(jù)的處理要求，如相關(guān)的計(jì)算公式、響應(yīng)時(shí)間，數(shù)據(jù)發(fā)生量，處理方式，輸出的要求等。有關(guān)數(shù)據(jù)項(xiàng)的描述參照以下格式進(jìn)行書寫：（至少要包括以下項(xiàng)目）字段名稱類型長度代碼字段說明default取值范圍備注序號(hào)Char5Xh本章節(jié)的標(biāo)題可以根據(jù)本軟件系統(tǒng)的相關(guān)數(shù)據(jù)結(jié)構(gòu)進(jìn)行安排}性能描述{從整體來說，本條應(yīng)具體說明軟件、或人與軟件交互的靜態(tài)或動(dòng)態(tài)數(shù)值需求，主要體現(xiàn)在軟件的相關(guān)性能要求上，如系統(tǒng)的處理能力、數(shù)據(jù)精度、響應(yīng)時(shí)間等等，要求在性能的有關(guān)指標(biāo)上必須有量化的數(shù)值要求，具有一定的可測(cè)性。其中靜態(tài)數(shù)值需求包括：可支持的終端或客戶端數(shù)、可支持并行操作的用戶數(shù)、可處理的記錄數(shù)或字節(jié)數(shù)、所用到的表和各種數(shù)據(jù)資料的大?。粍?dòng)態(tài)數(shù)值需求包括，欲處理的事務(wù)和任務(wù)或進(jìn)程的數(shù)量、在正常情況何峰值工作條件下的一定時(shí)間周期中處理的數(shù)據(jù)總量等等對(duì)精度需求的要求：要說明有關(guān)數(shù)據(jù)的允許誤差范圍在多大的范圍內(nèi)，要求的數(shù)據(jù)精度達(dá)到小數(shù)點(diǎn)后面幾位小數(shù)，當(dāng)計(jì)算精度高于需求數(shù)據(jù)精度時(shí)，是采用整數(shù)部分取整，還是采取四舍五入的原則等要求對(duì)數(shù)據(jù)容量的要求：對(duì)某些業(yè)務(wù)數(shù)據(jù)發(fā)生批量處理時(shí)達(dá)到某種峰值情況下的容量要求，如對(duì)于證券交易的每日交易量可能會(huì)達(dá)到多大的極限，同時(shí)處理批量委托數(shù)據(jù)的數(shù)據(jù)容量情況，為此需要保證多大容量的硬盤空間及需要多少配置的高性能的計(jì)算機(jī)系統(tǒng)作為硬件基礎(chǔ)等等對(duì)速度的要求：在響應(yīng)和處理速度方面滿足使用需求在多少硬件配置或相似性能的硬件基礎(chǔ)的前提下，要求業(yè)務(wù)處理在一秒內(nèi)完成多少筆業(yè)務(wù)數(shù)據(jù)的實(shí)時(shí)采集，各種委托或報(bào)表數(shù)據(jù)的查詢可根據(jù)數(shù)據(jù)量，要求控制在多少秒之內(nèi)完成處理，盤后清算處理過程必須在半小時(shí)之內(nèi)完成等等對(duì)可靠性的要求：說明系統(tǒng)必須在正常情況下運(yùn)行穩(wěn)定，并在非正?；蛞馔馇闆r下具有一定的堅(jiān)固性。在正常情況下，必須保證系統(tǒng)運(yùn)行的完整性等等，通常情況下，可靠性可用以下幾種指標(biāo)進(jìn)行評(píng)估：可用時(shí)間占比（xx.xx%）、平均故障間隔時(shí)間(x小時(shí))、平均修復(fù)時(shí)間（x小時(shí)）等等}接口描述{為可選項(xiàng)，若存在有關(guān)的接口并且需要特別說明，否則容易產(chǎn)生用戶和開發(fā)者對(duì)需求的二義性時(shí)需要詳細(xì)描述，如用戶界面、軟件接口與硬件接口等。用戶界面，主要用來定義本需求分析報(bào)告中所涉及到的各種用戶界面，可包括描述屏幕的布局、輸入/輸出項(xiàng)的屬性、功能鍵/按鈕的操作等等，具體描述的詳細(xì)程度可以根據(jù)具體項(xiàng)目的實(shí)際需要來決定。用戶界面的描述可以詳細(xì)到每一個(gè)具體屏幕，也可以只分成幾個(gè)大類進(jìn)行定義（如：分為輸入屏幕、查詢屏幕、修改屏幕等幾個(gè)大類）。用戶界面包括以下幾種形式：屏幕格式、報(bào)表或菜單的頁面打印格式和程序功能鍵的可用性等。如果用戶界面的定義與某個(gè)功能相關(guān)，可以合并在第三章功能描述進(jìn)行說明。有關(guān)用戶接口的說明，如屏幕格式或報(bào)表模板格式可以作為本需求分析報(bào)告的附件進(jìn)行保存，也可以直接使用用戶提供的原始表單或手寫底稿模板作為附件保存。軟件接口：指定需使用的其他軟件產(chǎn)品，以及同其他應(yīng)用系統(tǒng)之間的有關(guān)接口硬件接口：指出軟件產(chǎn)品和系統(tǒng)硬件部件之間的每一個(gè)接口的邏輯特點(diǎn)。通信接口：指定各種通信接口、網(wǎng)絡(luò)協(xié)議等信息}其他要求{主要描述與本軟件系統(tǒng)相關(guān)的各種屬性的要求，可包括：可用性、安全性、可維護(hù)性、可移植性等等?？捎眯裕嚎梢灾付ㄒ恍┮蛩?，如檢查點(diǎn)、恢復(fù)和再啟動(dòng)等，以保證整個(gè)系統(tǒng)有一個(gè)確定的可用性級(jí)別，如在適當(dāng)?shù)臅r(shí)間點(diǎn)上，要有適當(dāng)?shù)南到y(tǒng)數(shù)據(jù)備份和數(shù)據(jù)