軟件需求分析報告文檔模板

1、第-1-頁軟件需求分析報告文檔模板軟件需求分析報告文檔模板目錄1. 引言引言 .11.1 編寫目的.11.2 項目風險.11.3 文檔約定.11.4 預期讀者和閱讀建議.11.5 產品范圍.21.6 參考文獻.22. 綜合描述綜合描述 .22.1 產品的狀況.22.2 產品的功能.32.3 用戶類和特性.32.4 運行環(huán)境.32.5 設計和實現上的限制.32.6 假設和約束(依賴).43. 外部接口需求外部接口需求 .43.1 用戶界面.43.2 硬件接口.53.3 軟件接口.53.4 通訊接口.64. 系統(tǒng)功能需求系統(tǒng)功能需求 .64.1 說明和優(yōu)先級.64.2 激勵響應序列.74.3 輸入

2、輸出數據.75. 其它非功能需求其它非功能需求 .75.1 性能需求.75.2 安全措施需求.85.3 安全性需求.85.4 軟件質量屬性.85.5 業(yè)務規(guī)則.85.6 用戶文檔.86. 詞匯表詞匯表 .97. 數據定義數據定義 .98. 分析模型分析模型 .99. 待定問題列表待定問題列表 .10第-2-頁1. 引言引言引言是對這份軟件產品需求分析報告的概覽，是為了幫助閱讀者了解這份文檔是如何編寫的，并且應該如何閱讀、理解和解釋這份文檔。1.1 編寫目的編寫目的說明這份軟件產品需求分析報告是為哪個軟件產品編寫的，開發(fā)這個軟件產品意義、作用、以及最終要達到的意圖。通過這份軟件產品需求分析報告詳

3、盡說明了該軟件產品的需求規(guī)格，包括修正和(或)發(fā)行版本號，從而對該軟件產品進行準確的定義。1.2 項目風險項目風險具體說明本軟件開發(fā)項目的全部風險承擔者，以及各自在本階段所需要承擔的主要風險，首要風險承擔者包括： 任務提出者 軟件開發(fā)者 產品使用者1.3 文檔約定文檔約定描述編寫文檔時所采用的標準(如果有標準的話)，或者各種排版約定。排版約定應該包括 正文風格： 提示方式： 重要符號： 也應該說明高層次需求是否可以被其所有細化的需求所繼承，或者每個需求陳述是否都有其自己的優(yōu)先級。1.4 預期讀者和閱讀建議預期讀者和閱讀建議列舉本軟件產品需求分析報告所針對的各種不同的預期讀者，例如，可能包括 用

4、戶； 開發(fā)人員； 項目經理； 營銷人員； 測試人員； 文檔編寫入員。并且描述了文檔中，其余部分的內容及其組織結構，并且針對每一類讀者提出最適合的文檔閱讀建議第-3-頁1.5 產品范圍產品范圍說明該軟件產品及其開發(fā)目的的簡短描述，包括利益和目標。把軟件產品開發(fā)與企業(yè)目標，或者業(yè)務策略相聯(lián)系。描述產品范圍時需注意，可以參考項目視圖和范圍文檔，但是不能將其內容復制到這里。1.6 參考文獻參考文獻列舉編寫軟件產品需求分析報告時所用到的參考文獻及資料，可能包括： 本項目的合同書 上級機關有關本項目的批文 本項目已經批準的計劃任務書 用戶界面風格指導 開發(fā)本項目時所要用到的標淮 系統(tǒng)規(guī)格需求說明 使用實例

5、文檔 屬于本項目的其它己發(fā)表文件 本軟件產品需求分析報告中所引用的文件、資料 相關軟件產品需求分析報告為了方便讀者查閱，所有參考資料應該按一定順序排列。如果可能，每份資料都應該給出： 標題名稱； 作者或者合同簽約者； 文件編號或者版本號； 發(fā)表日期或者簽約日期； 出版單位或者資料來源。2. 綜合描述綜合描述這一部分概述了正在定義的軟件產品的作用范圍以及該軟件產品所運行的環(huán)境、使用該軟件產品的用戶、對該軟件產品己知的限制、有關該軟件產品的假設和依賴。2.1 產品的狀況產品的狀況描述了在軟件產品需求分析報告中所定義的軟件產品的背景和起源。說明了該軟件產品是否屬于下列情況： 是否是產品系列中的下一成

6、員 是否是成熟產品所改進的下一代產品 是否是現有應用軟件的替代品(升級產品) 是否是一個新型的、自主型的產品如果該軟件產品需求分析報告定義的軟件系統(tǒng)是第-4-頁 大系統(tǒng)的一個組成部分 與其它系統(tǒng)和其它機構之間存在基本的相互關系那么必須說明軟件產品需求分析報告定義的這部分軟件是怎樣與整個大系統(tǒng)相關聯(lián)的，或者（同時）說明相互關系的存在形式，并且要定義出兩者之間的全部接口。2.2 產品的功能產品的功能因為將在需求分析報告的第 4 部分中詳細描述軟件產品的功能，所以在此只需要概略地總結。僅從業(yè)務層面陳述本軟件產品所應具有的主要功能，在描述功能時應該針對每一項需求準確地描述其各項規(guī)格說明。如果存在引起誤

7、解的可能，在陳述本軟件產品主要功能的作用領域時，也需要對應陳述本軟件產品的非作用領域，以利讀者理解本軟件產品。2.3 用戶類和特性用戶類和特性確定有可能使用該軟件產品的不同用戶類，并且描述它們相關的特征。往往有一些軟件需求，只與特定的用戶類有關。描述時，應該將該軟件產品的重要用戶類與非重要用戶類區(qū)分開。用戶不一定是軟件產品的直接使用者，通過報表、應用程序接口、系統(tǒng)硬件接口得到軟件產品的數據和服務的人、或者機構也有他們的需求。所以，應該將這些外部需求視為通過報表、應用程序接口、系統(tǒng)硬件接口附加給軟件產品的附加用戶類。2.4 運行環(huán)境運行環(huán)境本軟件的運行環(huán)境，包括： 硬件平臺 操作系統(tǒng)和版本 支撐

8、環(huán)境(例如：數據庫等)和版本 其它與該軟件有關的軟件組件 與該軟件共存的應用程序2.5 設計和實現上的限制設計和實現上的限制確定影響開發(fā)人員自由選擇的問題，并且說明這些問題為什么成為一種限制?？赡艿南拗瓢ㄏ铝袃热?必須使用的特定技術、工具、編程語言和數據庫 避免使用的特定技術、工具、編程語言和數據庫 要求遵循的開發(fā)規(guī)范和標準例如，如果由客戶的公司或者第三方公司負責軟件維護，就必須定義轉包者所使用的設計符號表示和編碼標準 企業(yè)策略的限制第-5-頁 政府法規(guī)的限制 工業(yè)標準的限制 硬件的限制 數據轉換格式標淮的限制2.6 假設和約束假設和約束(依賴依賴)列舉出對軟件產品需求分析報告中，影響需求陳

9、述的假設因素(與己知因素相對立)。如果這些假設因素不正確、不一致或者被修改，就會使軟件產品開發(fā)項目受到影響。這些假設的因素可能包括 計劃使用的商業(yè)組件，或者其它軟件中的某個部件 假定產品中某個用戶界面將符合一個特殊的設計約定 有關本軟件用戶的若干假定(例如：假定用戶會熟練使用 SQL 語言。) 有關本軟件開發(fā)工作的若干假定(例如：用戶承諾的優(yōu)惠、方便、上級部門給予的特殊政策和支持等。) 有關本軟件運行環(huán)境的一些問題此外，確定本軟件開發(fā)項目對外部約束因素所存在的依賴。有關的約束可能包括 工期約束 經費約束 人員約束 設備約束 地理位置約束 其它有關項目約束3. 外部接口需求外部接口需求通過本節(jié)描

10、述可以確定，保證軟件產品能和外部組件正確連接的需求。關聯(lián)圖僅能表示高層抽象的外部接口，必須對接口數據和外部組件進行詳細描述，并且寫入數據定義中。如果產品的不同部分有不同的外部接口，那么應該把這些外部接口的全部詳細需求并入到這一部分實例中。注意：必須將附加用戶類的特征與外部接口需求加以區(qū)分，附加用戶類的特征描述的是通過接口取得軟件產品的數據和服務的人的需求；而外部接口需求描述的是接口本身的需求。3.1 用戶界面用戶界面陳述需要使用在用戶界面上的軟件組件，描述每一個用戶界面的邏輯特征。必須注意，這里需要描述的是用戶界面的邏輯特征，而不是用戶界面。以下是可能包括的一些特征 將要采用的圖形用戶界面(G

11、Ul)標準或者產品系列的風格 有關屏幕布局或者解決方案的限制 將要使用在每一個屏幕(圖形用戶界面)上的軟件組件 快捷鍵第-6-頁 各種顯示格式的規(guī)定 錯誤信息顯示標準；對于用戶界面的細節(jié)，例如：一個特定對話框的布局，應該寫入具體的用戶界面設計說明中，而不能寫入軟件需求規(guī)格說明中3.2 硬件接口硬件接口描述待開發(fā)的軟件產品與系統(tǒng)硬件接口的特征，若有多個硬件接口，則必須全都描述。接口特征的描述內容可能包括 支持的硬件類型； 軟、硬件之間交流的數據； 控制信息的性質； 使用的通訊協(xié)議；3.3 軟件接口軟件接口描述該軟件產品與其它外部組件的連接，這些外部組件必須明確它們的名稱和版本號以資識別，可能的外

12、部組件包括 操作系統(tǒng)； 數據庫； 工具； 函數庫； 集成的商業(yè)組件說明：這里所說的“集成的商業(yè)組件” ，是指與系統(tǒng)集成的商業(yè)組件，而不是與軟件產品集成的商業(yè)組件。例如：中間件、消息服務，等等。描述并且明確軟件產品與軟件組件之間交換數據或者消息的目的。描述所需要的服務，以及與內部組件通訊的性質。確定軟件產品將與組件之間共享的數據。如果必須使用一種特殊的方法來實現數據共享機制，例如：在多用戶系統(tǒng)中的一個全局數據區(qū)，那么就必須把它定義為一種實現上的限制。3.4 通訊接口通訊接口描述與軟件產品所使用的通訊功能相關的需求，包括 電子郵件； WEB 瀏覽器； 網絡通訊標準或者協(xié)議； 數據交互用電子表格；必

13、須定義相關的： 消息格式； 通訊安全或加密問題； 數據傳輸速率； 同步和異步通訊機制；第-7-頁4. 系統(tǒng)功能需求系統(tǒng)功能需求需要進行詳細的需求記錄，詳細列出與該系統(tǒng)功能相關的詳細功能需求，并且，唯一地標識每一項需求。這是必須提交給用戶的軟件功能，使得用戶可以使用所提供的功能執(zhí)行服務或者使用所指定的使用實例執(zhí)行任務。描述軟件產品如何響應己知的出錯條件、非法輸入、非法動作。對應一些被共享的獨立使用實例，可以定義一些公用系統(tǒng)功能。4.1 說明和優(yōu)先級說明和優(yōu)先級對該系統(tǒng)功能進行簡短的說明，并且指出該系統(tǒng)功能的優(yōu)先級是：高、中、還是低。需要的話，還可以包括對特定優(yōu)先級部分的評價，例如：利益、損失、費

14、用和風險，其相對優(yōu)先等級可以從 1(低)到 9(高)。4.2 激勵響應序列激勵響應序列列出輸入激勵(用戶動作、來自外部設備的信號或者其它觸發(fā))并且定義針對這功能行為的系統(tǒng)響應序列，這些序列將與使用實例中相關的對話元素相對應。描述激勵響應序列時，不僅需要描述基本過程，而且應該描述可選(擴充)過程，包括例外(引起任務不能順序完成的情況稱為例外)。疏忽了可選過程，有可能影響軟件產品的功能；如果遺漏例外過程，則有可能會引發(fā)系統(tǒng)崩潰。如果采用流程圖來描述激勵響應序列，比較容易讓用戶理解。4.3 輸入輸出數據輸入輸出數據列出輸入數據(用戶輸入、來自外部接口的輸入或者其它輸入)并且定義針對這些輸入數據的處理

15、(計算)方法，以及相應地輸出數據，描述對應區(qū)別：輸入數據和輸出數據。 對于每一項數據，均需要描述 數據名稱； 實際含義； 數據類型； 數據格式； 數據約束；對于復雜的處理方法，僅僅給出算法原理是不夠的，必須描述詳細的計算過程，并且列出每一步具體使用的實際算式；如果計算過程中涉及查表、判斷、迭代等處理方法，應該給出處理依據和相關數據。如果計算方法很簡單，也可以將其從略，不加描述。第-8-頁5. 其它非功能需求其它非功能需求在這里列舉出所有非功能需求，主要包括可靠性、安全性、可維護性、可擴展性、可測試性等。5.1 性能需求性能需求闡述不同應用領域對軟件產品性能的需求，并且說明提出需求的原理或者依據

16、，以幫助開發(fā)人員做出合理的設計選擇。盡可能詳細地描述性能需求，如果需要，可以針對每個功能需求或者特征分別陳述其性能需求。在這里確定： 相互合作的用戶數量； 系統(tǒng)支持的并發(fā)操作數量； 響應時間； 與實時系統(tǒng)的時間關系： 容量需求存儲器；磁盤空間；數據庫中表的最大行數。5.2 安全措施需求安全措施需求詳盡陳述與軟件產品使用過程中可能發(fā)生的損失、破壞、危害相關的需求。定義必須采取的安全保護或動作，以及必須預防的潛在危險動作。明確軟件產品必須遵從的安全標準、策略、或規(guī)則。5.3 安全性需求安全性需求詳盡陳述與系統(tǒng)安全性、完整性問題相關的需求，或者與個人隱私問題相關的需求。這些問題將會影響到軟件產品的使

17、用，和軟件產品所創(chuàng)建或者使用的數據的保護。定義用戶身份認證，或備授權需求。明確軟件產品必須滿足的安全性或者保密性策略。也可以通過稱為完整性的質量屬性來闡述這些需求。5.4 軟件質量屬性軟件質量屬性 詳盡陳述對客戶和開發(fā)人員至關重要的在軟件產品其它方面表現出來的質量功能。這些功能必須是確定的、定量的、在需要時是可以驗證的。至少也應該指明不同屬性的相對側重點，例如：易用性優(yōu)于易學性，或者可移植性優(yōu)于有效性。第-9-頁5.5 業(yè)務規(guī)則業(yè)務規(guī)則列舉出有關軟件產品的所有操作規(guī)則，例如：那些人在特定環(huán)境下可以進行何種操作。這些本身不是功能需求，但是他們可以暗示某些功能需求執(zhí)行這些規(guī)則。5.6 用戶文檔用戶文檔列舉出將與軟件產品一同交付的用戶文檔，并且明確所有己知用戶文檔的交付格式或標準，6. 詞匯表詞匯表列出本文件中用到的專業(yè)術語的定義，以及有關縮寫的定義(如有可能，列出相關的外文原詞)。為了便于非軟件專業(yè)或者非計算機專業(yè)人士閱讀軟件產品需求分析報告，要求使用非軟件專業(yè)或者非計算機專業(yè)的術語描述軟件需求。所以這里所指的專業(yè)術語，是指業(yè)務層面上的專業(yè)術語，而不是軟件專業(yè)或者計算機專業(yè)的術語。但是，對于無法回避的軟件專業(yè)或者計算機專業(yè)術語，也應該列入詞匯表并且加以準確定義。7. 數據定義數據定義數據定義