
附錄A 軟件需求分析報告文檔模板
附錄B 軟件概要設計報告文檔模板
附錄C 軟件詳細設計報告文檔模板
附錄D 軟件數據庫設計報告文檔模板
附錄E 軟件測試(驗收)大綱5
附錄A 軟件需求分析報告文檔模板
1. 引言
1.1 編寫目的
1.2 項目風險
1.3 文檔約定
1.4 預期讀者和閱讀建議
1.5 產品范圍
1.6 參考文獻
2. 綜合描述
2.1 產品的狀況
2.2 產品的功能
2.3 用戶類和特性
2.4 運行環境
2.5 設計和實現上的限制
2.6 假設和約束(依賴)
3. 外部接口需求
3.1 用戶界面
3.2 硬件接口
3.3 軟件接口
3.4 通訊接口
4. 系統功能需求
4.1 說明和優先級
4.2 激勵/響應序列
4.3 輸入/輸出數據
5. 其它非功能需求
5.1 性能需求
5.2 安全措施需求
5.3 安全性需求
5.4 軟件質量屬性
5.5 業務規則
5.6 用戶文檔
6. 詞匯表
7. 數據定義
8. 分析模型
9. 待定問題列表
1. 引言
引言是對這份軟件產品需求分析報告的概覽,是為了幫助閱讀者了解這份文檔是如何編寫的,并且應該如何閱讀、理解和解釋這份文檔。
1.1 編寫目的
說明這份軟件產品需求分析報告是為哪個軟件產品編寫的,開發這個軟件產品意義、作用、以及最終要達到的意圖。通過這份軟件產品需求分析報告詳盡說明了該軟件產品的需求規格,包括修正和(或)發行版本號,從而對該軟件產品進行準確的定義。
如果這份軟件產品需求分析報告只與整個系統的某一部分有關系,那么只定義軟件產品需求分析報告中說明的那個部分或子系統。
1.2 項目風險
具體說明本軟件開發項目的全部風險承擔者,以及各自在本階段所需要承擔的主要風險,首要風險承擔者包括:
● 任務提出者;
● 軟件開發者;
● 產品使用者。
1.3 文檔約定
描述編寫文檔時所采用的標準(如果有標準的話),或者各種排版約定。排版約定應該包括:
● 正文風格;
● 提示方式;
● 重要符號;
也應該說明高層次需求是否可以被其所有細化的需求所繼承,或者每個需求陳述是否都有其自己的優先級。
1.4 預期讀者和閱讀建議
列舉本軟件產品需求分析報告所針對的各種不同的預期讀者,例如,可能包括:
● 用戶;
● 開發人員;
● 項目經理;
● 營銷人員;
● 測試人員;
● 文檔編寫入員。
并且描述了文檔中,其余部分的內容及其組織結構,并且針對每一類讀者提出最適合的文檔閱讀建議。
1.5 產品范圍
說明該軟件產品及其開發目的的簡短描述,包括利益和目標。把軟件產品開發與企業目標,或者業務策略相聯系。
描述產品范圍時需注意,可以參考項目視圖和范圍文檔,但是不能將其內容復制到這里。
1.6 參考文獻
列舉編寫軟件產品需求分析報告時所用到的參考文獻及資料,可能包括:
● 本項目的合同書;
● 上級機關有關本項目的批文;
● 本項目已經批準的計劃任務書;
● 用戶界面風格指導;
● 開發本項目時所要用到的標淮;
● 系統規格需求說明;
● 使用實例文檔;
● 屬于本項目的其它己發表文件;
● 本軟件產品需求分析報告中所引用的文件、資料;
● 相關軟件產品需求分析報告;
為了方便讀者查閱,所有參考資料應該按一定順序排列。如果可能,每份資料都應該給出:
● 標題名稱;
● 作者或者合同簽約者;
● 文件編號或者版本號;
● 發表日期或者簽約日期;
● 出版單位或者資料來源。
2. 綜合描述
這一部分概述了正在定義的軟件產品的作用范圍以及該軟件產品所運行的環境、使用該軟件產品的用戶、對該軟件產品己知的限制、有關該軟件產品的假設和依賴。
2.1 產品的狀況
描述了在軟件產品需求分析報告中所定義的軟件產品的背景和起源。說明了該軟件產品是否屬于下列情況:
● 是否是產品系列中的下一成員;
● 是否是成熟產品所改進的下一代產品;
● 是否是現有應用軟件的替代品(升級產品);
● 是否是一個新型的、自主型的產品。
如果該軟件產品需求分析報告定義的軟件系統是:
● 大系統的一個組成部分;
● 與其它系統和其它機構之間存在基本的相互關系。
那么必須說明軟件產品需求分析報告定義的這部分軟件是怎樣與整個大系統相關聯的,或者(同時)說明相互關系的存在形式,并且要定義出兩者之間的全部接口。
2.2 產品的功能
因為將在需求分析報告的第4部分中詳細描述軟件產品的功能,所以在此只需要概略地總結。僅從業務層面陳述本軟件產品所應具有的主要功能,在描述功能時應該針對每一項需求準確地描述其各項規格說明。如果存在引起誤解的可能,在陳述本軟件產品主要功能的作用領域時,也需要對應陳述本軟件產品的非作用領域,以利讀者理解本軟件產品。
為了很好地組織產品功能,使每個讀者都容易理解,可以采用列表的方法給出。也可以采用圖形方式,將主要的需求分組以及它們之間的聯系使用數據流程圖的頂層圖或類圖進行表示,這種表示方法是很有用的。
參考用戶當前管理組織構架,了解各個機構的主要職能,將有助于陳述軟件產品的主要功能。
2.3 用戶類和特性
確定有可能使用該軟件產品的不同用戶類,并且描述它們相關的特征。往往有一些軟件需求,只與特定的用戶類有關。描述時,應該將該軟件產品的重要用戶類與非重要用戶類區分開。