軟件需求分析報告報告材料文檔-實(shí)用模板

1、附錄A軟件需求分析報告文檔模板1.引言21.1編寫目的21.2項(xiàng)目風(fēng)險21.3文檔約定21.4預(yù)期讀者和閱讀建議 21.5產(chǎn)品范圍31.6參考文獻(xiàn) 32. 綜合描述32.1產(chǎn)品的狀況 32.2產(chǎn)品的功能 42.3用戶類和特性 42.4運(yùn)行環(huán)境42.5設(shè)計(jì)和實(shí)現(xiàn)上的限制 42.6假設(shè)和約束（依賴） 53. 外部接口需求53.1用戶界面53.2硬件接口 63.3軟件接口 63.4通訊接口 74. 系統(tǒng)功能需求74.1說明和優(yōu)先級 74.2激勵/響應(yīng)序列 84.3輸入/輸岀數(shù)據(jù) 85. 其它非功能需求 85.1性能需求85.2安全措施需求 95.3安全性需求 95.4軟件質(zhì)量屬性 95.5業(yè)務(wù)規(guī)則

2、95.6用戶文檔 96. 詞匯表107. 數(shù)據(jù)定義108. 分析模型119. 待定問題列表111.引言是為了幫助閱讀者了解這份文檔是如何編引言是對這份軟件產(chǎn)品需求分析報告的概覽, 寫的，并且應(yīng)該如何閱讀、理解和解釋這份文檔。1.1編寫目的說明這份軟件產(chǎn)品需求分析報告是為哪個軟件產(chǎn)品編寫的，開發(fā)這個軟件產(chǎn)品意義、 作用、以及最終要達(dá)到的意圖。 通過這份軟件產(chǎn)品需求分析報告詳盡說明了該軟件產(chǎn)品的需求 規(guī)格，包括修正和（或）發(fā)行版本號，從而對該軟件產(chǎn)品進(jìn)行準(zhǔn)確的定義。如果這份軟件產(chǎn)品需求分析報告只與整個系統(tǒng)的某一部分有關(guān)系，那么只定義軟件產(chǎn)品需求分析報告中說明的那個部分或子系統(tǒng)。1.2項(xiàng)目風(fēng)險具體說

3、明本軟件開發(fā)項(xiàng)目的全部風(fēng)險承擔(dān)者，以及各自在本階段所需要承擔(dān)的主要風(fēng)險，首要風(fēng)險承擔(dān)者包括：任務(wù)提出者；軟件開發(fā)者；產(chǎn)品使用者。1.3文檔約定描述編寫文檔時所采用的標(biāo)準(zhǔn) （如果有標(biāo)準(zhǔn)的話），或者各種排版約定。排版約定應(yīng)該包括：正文風(fēng)格；提示方式；重要符號；也應(yīng)該說明高層次需求是否可以被其所有細(xì)化的需求所繼承，或者每個需求陳述是否都有其自己的優(yōu)先級。1.4預(yù)期讀者和閱讀建議列舉本軟件產(chǎn)品需求分析報告所針對的各種不同的預(yù)期讀者，例如，可能包括：用戶；開發(fā)人員；項(xiàng)目經(jīng)理；營銷人員；測試人員；文檔編寫入員。并且描述了文檔中，其余部分的內(nèi)容及其組織結(jié)構(gòu)，并且針對每一類讀者提出最適合的文檔閱讀建議。1.5

4、產(chǎn)品范圍說明該軟件產(chǎn)品及其開發(fā)目的的簡短描述，包括利益和目標(biāo)。把軟件產(chǎn)品開發(fā)與企業(yè)目標(biāo)，或者業(yè)務(wù)策略相聯(lián)系。描述產(chǎn)品范圍時需注意，可以參考項(xiàng)目視圖和范圍文檔， 但是不能將其內(nèi)容復(fù)制到這里。1.6參考文獻(xiàn)列舉編寫軟件產(chǎn)品需求分析報告時所用到的參考文獻(xiàn)及資料，可能包括：本項(xiàng)目的合同書； 上級機(jī)關(guān)有關(guān)本項(xiàng)目的批文； 本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃任務(wù)書；用戶界面風(fēng)格指導(dǎo)； 開發(fā)本項(xiàng)目時所要用到的標(biāo)淮；系統(tǒng)規(guī)格需求說明；使用實(shí)例文檔；屬于本項(xiàng)目的其它己發(fā)表文件； 本軟件產(chǎn)品需求分析報告中所引用的文件、資料；相關(guān)軟件產(chǎn)品需求分析報告；為了方便讀者查閱， 所有參考資料應(yīng)該按一定順序排列。如果可能，每份資料都應(yīng)該給出

5、：標(biāo)題名稱；作者或者合同簽約者；文件編號或者版本號； 發(fā)表日期或者簽約日期；出版單位或者資料來源。2. 綜合描述這一部分概述了正在定義的軟件產(chǎn)品的作用范圍以及該軟件產(chǎn)品所運(yùn)行的環(huán)境、使用該軟件產(chǎn)品的用戶、對該軟件產(chǎn)品己知的限制、有關(guān)該軟件產(chǎn)品的假設(shè)和依賴。2.1產(chǎn)品的狀況描述了在軟件產(chǎn)品需求分析報告中所定義的軟件產(chǎn)品的背景和起源。說明了該軟件產(chǎn)品是否屬于下列情況：是否是產(chǎn)品系列中的下一成員；是否是成熟產(chǎn)品所改進(jìn)的下一代產(chǎn)品；是否是現(xiàn)有應(yīng)用軟件的替代品（升級產(chǎn)品）； 是否是一個新型的、自主型的產(chǎn)品。如果該軟件產(chǎn)品需求分析報告定義的軟件系統(tǒng)是： 大系統(tǒng)的一個組成部分；與其它系統(tǒng)和其它機(jī)構(gòu)之間存在基

6、本的相互關(guān)系。那么必須說明軟件產(chǎn)品需求分析報告定義的這部分軟件是怎樣與整個大系統(tǒng)相關(guān)聯(lián)的， 或者（同時）說明相互關(guān)系的存在形式，并且要定義出兩者之間的全部接口。2.2產(chǎn)品的功能因?yàn)閷⒃谛枨蠓治鰣蟾娴牡?4部分中詳細(xì)描述軟件產(chǎn)品的功能，所以在此只需要概略地 總結(jié)。僅從業(yè)務(wù)層面陳述本軟件產(chǎn)品所應(yīng)具有的主要功能，在描述功能時應(yīng)該針對每一項(xiàng)需求準(zhǔn)確地描述其各項(xiàng)規(guī)格說明。如果存在引起誤解的可能，在陳述本軟件產(chǎn)品主要功能的作 用領(lǐng)域時，也需要對應(yīng)陳述本軟件產(chǎn)品的非作用領(lǐng)域，以利讀者理解本軟件產(chǎn)品。為了很好地組織產(chǎn)品功能， 使每個讀者都容易理解， 可以采用列表的方法給出。 也可以 采用圖形方式，將主要的需求

7、分組以及它們之間的聯(lián)系使用數(shù)據(jù)流程圖的頂層圖或類圖進(jìn)行 表示，這種表示方法是很有用的。參考用戶當(dāng)前管理組織構(gòu)架，了解各個機(jī)構(gòu)的主要職能，將有助于陳述軟件產(chǎn)品的主要 功能。2.3用戶類和特性確定有可能使用該軟件產(chǎn)品的不同用戶類，并且描述它們相關(guān)的特征。往往有一些軟件需求，只與特定的用戶類有關(guān)。 描述時，應(yīng)該將該軟件產(chǎn)品的重要用戶類與非重要用戶類區(qū) 分開。用戶不一定是軟件產(chǎn)品的直接使用者， 通過報表、應(yīng)用程序接口、系統(tǒng)硬件接口得到軟 件產(chǎn)品的數(shù)據(jù)和服務(wù)的人、或者機(jī)構(gòu)也有他們的需求。所以，應(yīng)該將這些外部需求視為通過 報表、應(yīng)用程序接口、系統(tǒng)硬件接口附加給軟件產(chǎn)品的附加用戶類。2.4運(yùn)行環(huán)境描述了本軟

8、件的運(yùn)行環(huán)境，一般包括：硬件平臺；操作系統(tǒng)和版本；支撐環(huán)境（例如：數(shù)據(jù)庫等）和版本；其它與該軟件有關(guān)的軟件組件； 與該軟件共存的應(yīng)用程序。2.5設(shè)計(jì)和實(shí)現(xiàn)上的限制確定影響開發(fā)人員自由選擇的問題，并且說明這些問題為什么成為一種限制?？赡艿南拗瓢ㄏ铝袃?nèi)容： 必須使用的特定技術(shù)、工具、編程語言和數(shù)據(jù)庫； 避免使用的特定技術(shù)、工具、編程語言和數(shù)據(jù)庫；要求遵循的開發(fā)規(guī)范和標(biāo)準(zhǔn)就必須定義轉(zhuǎn)包者所使用的設(shè)例如，如果由客戶的公司或者第三方公司負(fù)責(zé)軟件維護(hù), 計(jì)符號表示和編碼標(biāo)準(zhǔn)；企業(yè)策略的限制； 政府法規(guī)的限制；工業(yè)標(biāo)準(zhǔn)的限制；硬件的限制例如，定時需求或存儲器限制； 數(shù)據(jù)轉(zhuǎn)換格式標(biāo)淮的限制。2.6假設(shè)和約束

9、（依賴）列舉出對軟件產(chǎn)品需求分析報告中，影響需求陳述的假設(shè)因素（與己知因素相對立）。如果這些假設(shè)因素不正確、 不一致或者被修改， 就會使軟件產(chǎn)品開發(fā)項(xiàng)目受到影響。 這些假設(shè) 的因素可能包括： 計(jì)劃使用的商業(yè)組件，或者其它軟件中的某個部件； 假定產(chǎn)品中某個用戶界面將符合一個特殊的設(shè)計(jì)約定； 有關(guān)本軟件用戶的若干假定 （例如：假定用戶會熟練使用SQL語言。）； 有關(guān)本軟件開發(fā)工作的若干假定 （例如：用戶承諾的優(yōu)惠、方便、上級部門給予的特 殊政策和支持等。）； 有關(guān)本軟件運(yùn)行環(huán)境的一些問題；此外，確定本軟件開發(fā)項(xiàng)目對外部約束因素所存在的依賴。有關(guān)的約束可能包括：工期約束；經(jīng)費(fèi)約束；人員約束；設(shè)備約束

10、；地理位置約束；其它有關(guān)項(xiàng)目約束；3. 外部接口需求通過本節(jié)描述可以確定，保證軟件產(chǎn)品能和外部組件正確連接的需求。關(guān)聯(lián)圖僅能表示高層抽象的外部接口， 必須對接口數(shù)據(jù)和外部組件進(jìn)行詳細(xì)描述，并且寫入數(shù)據(jù)定義中。 如果產(chǎn)品的不同部分有不同的外部接口，那么應(yīng)該把這些外部接口的全部詳細(xì)需求并入到這一部分實(shí)例中。注意：必須將附加用戶類的特征與外部接口需求加以區(qū)分，附加用戶類的特征描述的是通過接口取得軟件產(chǎn)品的數(shù)據(jù)和服務(wù)的人的需求；而外部接口需求描述的是接口本身的需求。3.1用戶界面陳述需要使用在用戶界面上的軟件組件，描述每一個用戶界面的邏輯特征。必須注意, 這里需要描述的是用戶界面的邏輯特征，而不是用戶

11、界面。以下是可能包括的一些特征： 將要采用的圖形用戶界面（GUI）標(biāo)準(zhǔn)或者產(chǎn)品系列的風(fēng)格； 有關(guān)屏幕布局或者解決方案的限制； 將要使用在每一個屏幕（圖形用戶界面）上的軟件組件，可能包括:選單；標(biāo)準(zhǔn)按鈕；導(dǎo)航鏈接； 各種功能組件； 消息欄；快捷鍵； 各種顯示格式的規(guī)定，可能包括：不同情況下文字的對齊方式；不同情況下數(shù)字的表現(xiàn)格式與對齊方式 日期的表現(xiàn)方法與格式； 計(jì)時方法與時間格式；錯誤信息顯示標(biāo)準(zhǔn)；對于用戶界面的細(xì)節(jié)，例如：一個特定對話框的布局，應(yīng)該寫入具體的用戶界面設(shè)計(jì)說 明中，而不能寫入軟件需求規(guī)格說明中。如果采用現(xiàn)成的、合適的用戶界面設(shè)計(jì)規(guī)范（標(biāo)準(zhǔn)），或者另文描述，可以在這里直接說明，并

12、且將其加入?yún)⒖嘉墨I(xiàn)。3.2硬件接口描述待開發(fā)的軟件產(chǎn)品與系統(tǒng)硬件接口的特征，若有多個硬件接口，則必須全都描述。接口特征的描述內(nèi)容可能包括：支持的硬件類型；軟、硬件之間交流的數(shù)據(jù)；控制信息的性質(zhì)；使用的通訊協(xié)議；3.3軟件接口描述該軟件產(chǎn)品與其它外部組件的連接，這些外部組件必須明確它們的名稱和版本號以資識別，可能的外部組件包括：操作系統(tǒng)；數(shù)據(jù)庫；工具；函數(shù)庫；集成的商業(yè)組件說明：這里所說的“集成的商業(yè)組件”，是指與系統(tǒng)集成的商業(yè)組件，而不是與軟件產(chǎn)品集成的商業(yè)組件。例如：中間件、消息服務(wù)，等等。描述并且明確軟件產(chǎn)品與軟件組件之間交換數(shù)據(jù)或者消息的目的。描述所需要的服務(wù)，以及與內(nèi)部組件通訊的性質(zhì)。

13、 確定軟件產(chǎn)品將與組件之間共享的數(shù)據(jù)。 如果必須使用一種特 殊的方法來實(shí)現(xiàn)數(shù)據(jù)共享機(jī)制， 例如：在多用戶系統(tǒng)中的一個全局?jǐn)?shù)據(jù)區(qū)， 那么就必須把它 定義為一種實(shí)現(xiàn)上的限制。3.4通訊接口描述與軟件產(chǎn)品所使用的通訊功能相關(guān)的需求，包括: 電子郵件； WEB瀏覽器；網(wǎng)絡(luò)通訊標(biāo)準(zhǔn)或者協(xié)議；數(shù)據(jù)交互用電子表格；必須定義相關(guān)的：消息格式； 通訊安全或加密問題；數(shù)據(jù)傳輸速率； 同步和異步通訊機(jī)制；4. 系統(tǒng)功能需求需要進(jìn)行詳細(xì)的需求記錄，詳細(xì)列出與該系統(tǒng)功能相關(guān)的詳細(xì)功能需求，并且，唯一地標(biāo)識每一項(xiàng)需求。這是必須提交給用戶的軟件功能，使得用戶可以使用所提供的功能執(zhí)行服務(wù)或者使用所指定的使用實(shí)例執(zhí)行任務(wù)。 非

14、法動作。如果每一項(xiàng)功能需求都能用一項(xiàng)，認(rèn)為功能需求已經(jīng)適當(dāng)?shù)剡M(jìn)行描述了。描述軟件產(chǎn)品如何響應(yīng)己知的出錯條件、也只需要用一項(xiàng)測試用例就能進(jìn)行驗(yàn)證， 如果某項(xiàng)功能需求找不到合適的測試用例,非法輸入、那么就可以 或者必須使用多項(xiàng)測試用例才能驗(yàn)證，那么該項(xiàng)功能需求的描述必然存在某些問題。功能需求是根據(jù)系統(tǒng)功能， 即軟件產(chǎn)品所提供的主要服務(wù)來組織的。可以通過使用實(shí)例、運(yùn)行模式、用戶類、對象類或者功能等級來組織這部分內(nèi)容，也可以便用這些元素的組合?？偠灾?，必須選擇一種是讀者容易理解預(yù)期產(chǎn)品的組織方案。用簡短的語句說明功能的名稱，例如：“ 4.1系統(tǒng)參數(shù)管理”。按照服務(wù)組織的順序，逐條闡述系統(tǒng)功能。無論說

15、明的是何種功能，都應(yīng)該針對該系統(tǒng)功能重復(fù)敘述4.1 4.3這三個部分。可以通過各種方式來組織這一部分內(nèi)容，例如采用：使用實(shí)例、運(yùn)行模式、用戶類、對 象類、功能等級等，也可以采用它們的組合。其最終目的是，讓讀者容易理解即將開發(fā)的軟 件產(chǎn)品。一般來說，每個使用實(shí)例都對應(yīng)一個系統(tǒng)功能， 因而按照使用實(shí)例來組織內(nèi)容比較 容易讓用戶理解。對應(yīng)一些被共享的獨(dú)立使用實(shí)例，可以定義一些公用系統(tǒng)功能。必須特別注意的是，在2.2節(jié)“產(chǎn)品的功能”中描述的全部需求，以及它們的規(guī)格說明; 必須在某個系統(tǒng)功能描述中有所反映，而且不應(yīng)重復(fù)。4.1說明和優(yōu)先級對該系統(tǒng)功能進(jìn)行簡短的說明，并且指出該系統(tǒng)功能的優(yōu)先級是：高、中、

16、還是低。需 要的話，還可以包括對特定優(yōu)先級部分的評價，例如：利益、損失、費(fèi)用和風(fēng)險，其相對優(yōu) 先等級可以從1（低）到9（高）。4.2激勵/響應(yīng)序列列出輸入激勵（用戶動作、來自外部設(shè)備的信號或者其它觸發(fā)）并且定義針對這一一功能 行為的系統(tǒng)響應(yīng)序列，這些序列將與使用實(shí)例中相關(guān)的對話元素相對應(yīng)。描述激勵/響應(yīng)序列時，不僅需要描述基本過程，而且應(yīng)該描述可選（擴(kuò)充）過程，包括例外（引起任務(wù)不能順序完成的情況稱為例外）。疏忽了可選過程，有可能影響軟件產(chǎn)品的功能；如果遺漏例外過程，則有可能會引發(fā)系統(tǒng)崩潰。如果采用流程圖來描述激勵/響應(yīng)序列，比較容易讓用戶理解。4.3輸入/輸出數(shù)據(jù)列出輸入數(shù)據(jù)（用戶輸入、來自

17、外部接口的輸入或者其它輸入 ）并且定義針對這些輸入數(shù) 據(jù)的處理（計(jì)算）方法，以及相應(yīng)地輸出數(shù)據(jù)，描述對應(yīng)區(qū)別：輸入數(shù)據(jù)和輸出數(shù)據(jù)。當(dāng)有大量數(shù)據(jù)需要描述時，也可以分類描述數(shù)據(jù)，并且注明各項(xiàng)數(shù)據(jù)的輸入、 輸出屬性。 對于每一項(xiàng)數(shù)據(jù)，均需要描述：數(shù)據(jù)名稱；實(shí)際含義；數(shù)據(jù)類型；數(shù)據(jù)格式；數(shù)據(jù)約束；對于復(fù)雜的處理方法， 僅僅給出算法原理是不夠的，必須描述詳細(xì)的計(jì)算過程，并且列出每一步具體使用的實(shí)際算式；如果計(jì)算過程中涉及查表、判斷、迭代等處理方法，應(yīng)該給出處理依據(jù)和相關(guān)數(shù)據(jù)。如果計(jì)算方法很簡單，也可以將其從略，不加描述。5. 其它非功能需求在這里列舉出所有非功能需求，主要包括可靠性、安全性、可維護(hù)性、可

18、擴(kuò)展性、可測 試性等。5.1性能需求闡述不同應(yīng)用領(lǐng)域?qū)浖a(chǎn)品性能的需求，并且說明提出需求的原理或者依據(jù)，以幫助開發(fā)人員做出合理的設(shè)計(jì)選擇。盡可能詳細(xì)地描述性能需求，如果需要，可以針對每個功能 需求或者特征分別陳述其性能需求。在這里確定：相互合作的用戶數(shù)量；系統(tǒng)支持的并發(fā)操作數(shù)量；響應(yīng)時間；與實(shí)時系統(tǒng)的時間關(guān)系：容量需求存儲器； 磁盤空間；數(shù)據(jù)庫中表的最大行數(shù)。5.2安全措施需求詳盡陳述與軟件產(chǎn)品使用過程中可能發(fā)生的損失、破壞、危害相關(guān)的需求。 定義必須采取的安全保護(hù)或動作，以及必須預(yù)防的潛在危險動作。明確軟件產(chǎn)品必須遵從的安全標(biāo)準(zhǔn)、 策略、或規(guī)則。5.3安全性需求詳盡陳述與系統(tǒng)安全性、 完整

19、性問題相關(guān)的需求，或者與個人隱私問題相關(guān)的需求。這些問題將會影響到軟件產(chǎn)品的使用，和軟件產(chǎn)品所創(chuàng)建或者使用的數(shù)據(jù)的保護(hù)。定義用戶身份認(rèn)證，或備授權(quán)需求。明確軟件產(chǎn)品必須滿足的安全性或者保密性策略。也可以通過稱為完整性的質(zhì)量屬性來闡述這些需求。一個典型的軟件系統(tǒng)安全需求范例如下：“每個用戶在第一次登錄后，必須更改他的系統(tǒng)預(yù)置登錄密碼，系統(tǒng)預(yù)置的登錄密碼不能重用。”5.4軟件質(zhì)量屬性詳盡陳述對客戶和開發(fā)人員至關(guān)重要的在軟件產(chǎn)品其它方面表現(xiàn)出來的質(zhì)量功能。這些功能必須是確定的、 定量的、在需要時是可以驗(yàn)證的。 至少也應(yīng)該指明不同屬性的相對側(cè)重 點(diǎn)，例如：易用性優(yōu)于易學(xué)性，或者可移植性優(yōu)于有效性。5.

20、5業(yè)務(wù)規(guī)則列舉出有關(guān)軟件產(chǎn)品的所有操作規(guī)則，例如：那些人在特定環(huán)境下可以進(jìn)行何種操作。這些本身不是功能需求， 但是他們可以暗示某些功能需求執(zhí)行這些規(guī)則。一個業(yè)務(wù)規(guī)則的范例如下：“進(jìn)行達(dá)到或者超過 10，000, 00元人民幣的儲蓄業(yè)務(wù)時，必須通過附加的管理員 認(rèn)證。”列舉業(yè)務(wù)規(guī)則時，可以根據(jù)規(guī)則的數(shù)量，選取合適的編目方式。5.6用戶文檔列舉出將與軟件產(chǎn)品一同交付的用戶文檔，并且明確所有己知用戶文檔的交付格式或標(biāo)準(zhǔn)，例如：安裝指南紙質(zhì)文檔,16開本；用戶手冊紙質(zhì)文檔,16開本；在線幫助電子文檔，與軟件產(chǎn)品一同分發(fā)、配置；使用教程電子文檔，與軟件產(chǎn)品一同分發(fā)、配置。6.詞匯表列出本文件中用到的專業(yè)

21、術(shù)語的定義，以及有關(guān)縮寫的定義（如有可能，列出相關(guān)的外文原詞）。為了便于非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)人士閱讀軟件產(chǎn)品需求分析報告，要求使 用非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)的術(shù)語描述軟件需求。所以這里所指的專業(yè)術(shù)語，是指業(yè)務(wù)層面上的專業(yè)術(shù)語，而不是軟件專業(yè)或者計(jì)算機(jī)專業(yè)的術(shù)語。但是，對于無法回避的軟件專業(yè)或者計(jì)算機(jī)專業(yè)術(shù)語，也應(yīng)該列入詞匯表并且加以準(zhǔn)確定義。7. 數(shù)據(jù)定義數(shù)據(jù)定義是一個定義了應(yīng)用程序中使用的所有數(shù)據(jù)元素和結(jié)構(gòu)的共享文檔，其中對每個數(shù)據(jù)元素和結(jié)構(gòu)都準(zhǔn)確描述：含義、類型、數(shù)據(jù)大小、格式、計(jì)量單位、精度以及取值范圍。數(shù)據(jù)定義的維護(hù)獨(dú)立于軟件需求規(guī)格說明，并且在軟件產(chǎn)品開發(fā)和維護(hù)的任何階段，均向風(fēng)險承擔(dān)者開放。如果為軟件開發(fā)項(xiàng)目創(chuàng)建一個獨(dú)立的數(shù)據(jù)定義，而不是為每一項(xiàng)特性描述有關(guān)的數(shù)據(jù)項(xiàng)，有利于避免冗余和不一致性。但是卻不利于多人協(xié)同編寫需求分析報告，容易遺漏數(shù)據(jù)，也不方便閱讀。因此還是建議為每個特性描述有關(guān)的數(shù)據(jù)