【软件工程】软件需求说明书、概要设计说明书、详细设计说明书参考模板
文章目錄
- 軟件需求說明書
- 一、引言
- 1. 編寫目的
- 2. 背景
- 3. 定義
- 4. 參考資料
- 二、任務概述
- 1. 目標
- 2. 用戶的特點
- 3. 假定和約束
- 三、需求規定
- 1. 對功能的規定
- 2. 對性能的規定
- （1）精度
- （2）時間特性要求
- （3）靈活性
- 3. 輸入輸出要求
- 4. 數據管理能力要求
- 5. 故障處理要求
- 6. 其他專門要求
- 四、運行環境規定
- 1. 設備
- 2. 支持軟件
- 3. 接口
- 4. 控制
- 概要設計說明書
- 一、引言
- 1. 編寫目的
- 2. 背景
- 3. 定義
- 4. 參考資料
- 二、總體設計
- 1. 需求規定
- 2. 運行環境
- 3. 基本設計概念和處理流程
- 4. 結構
- 5. 功能需求與程序的關系
- 6. 人工處理過程
- 7. 尚未解決的問題
- 三、接口設計
- 1. 用戶接口
- 2. 外部接口
- 3. 內部接口
- 四、運行設計
- 1. 運行模塊組合
- 2. 運行控制
- 3. 運行時間
- 五、系統數據結構設計
- 1. 邏輯結構設計要點
- 2. 物理結構設計要點
- 3. 數據結構與程序的關系
- 六、系統出錯處理設計
- 1. 出錯信息
- 2. 補救措施
- 3. 系統維護設計
- 詳細說明設計書
- 一、引言
- 1. 編寫目的
- 2. 背景
- 3. 定義
- 4. 參考資料
- 二、程序系統的結構
- 三、程序1（標識符）設計說明
- 1. 程序描述
- 2. 功能
- 3. 性能
- 4. 輸入項
- 5. 輸出項
- 6. 算法
- 7. 流程邏輯
- 8. 接口
- 9. 存儲分配
- 10. 注釋設計
- 11. 限制條件
- 12. 測試計劃
- 13. 尚未解決的問題
- 四、程序2（標識符）設計說明
參考《大學本科計算機專業應用型規劃教材——實用軟件文檔寫作》一書。
軟件需求說明書
一、引言
1. 編寫目的
說明編寫這份軟件需求說明書的目的，指出預期的讀者。
2. 背景
說明：
- 待開發軟件系統的名稱
- 本項目的任務提出者、開發者、用戶、以及實現該軟件的計算中心或計算機網絡
- 該軟件系統同其他系統或其他機構的基本的相互往來關系。
3. 定義
列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組。
4. 參考資料
列出用得著的參考資料，如：
- 本項目的經核準的計劃任務書或合同、上級機關的批文；
- 屬于本項目的其他已發表文件；
- 本文件中各處引用的文件、資料，包括所要用到的軟件開發標準；
列出這些文件的標題、文件編號、發表日期、出版單位，說明能夠得到這些文件資料的來源。
二、任務概述
1. 目標
敘述該項軟件開發的意圖、應用目標、作用范圍以及其他應向讀者說明的、有關該軟件開發的背景資料。解釋被開發軟件與其他有關軟件之間的關系。如果本軟件產品是一項獨立的軟件，而且全部內容自含，則說明這一點。如果所定義的產品是一個更大的系統的一個組成部分，則應說明本產品與該系統中其他各組成部分之間的關系，為此可使用一個方框圖來說明該系統的組成和本產品同其他各部分的聯系和接口。
2. 用戶的特點
列出本軟件的最終用戶的特點，充分說明操作人員、維護人員的教育水平和技術專長，以及本軟件的預期使用頻度。這些是軟件設計工作的重要約束。
3. 假定和約束
列出進行本軟件開發工作的假定和約束，例如經費限制、開發期限等。
三、需求規定
1. 對功能的規定
用列表的方式（例如IPO表，即輸入-處理-輸出表的形式），逐項定量和定性地敘述對軟件所提出的功能要求，說明輸入什么量、經怎樣的處理、得到什么輸出，說明軟件應支持的終端數和應支持的并發操作的用戶數。
2. 對性能的規定
（1）精度
說明對該軟件的輸入、輸出數據精度的要求，可能包括傳輸過程中的精度。
（2）時間特性要求
說明對于該軟件的時間特性要求，如：
- 響應時間；
- 更新處理時間；
- 數據的轉換和傳送時間；
- 解題時間。
（3）靈活性
說明對該軟件的靈活性的要求，即當需求發生某些變化時，該軟件對這些變化的適應能力，如：
- 操作方式上的變化；
- 運行環境的變化；
- 同其他軟件的接口的變化；
- 精度和有效時限的變化；
- 計劃的變化或改進
對于為了提供這些靈活性而進行的專門設計的部分，應該加以標明。
3. 輸入輸出要求
解釋各輸入輸出數據類型，并逐項說明其媒體、格式、數值范圍、精度等。對軟件的數據輸出及必須標明的控制輸出量進行解釋并舉例，包括對硬拷貝報告（正常結果輸出、狀態輸出及異常輸出）以及圖形或顯示報告的描述。
4. 數據管理能力要求
說明需要管理的文卷和記錄的個數、表和文卷的大小規模，要按可預見的增長對數據及其分量的存儲要求做出估算。
5. 故障處理要求
列出可能的軟件、硬件故障以及對各項性能而言所產生的后果和對故障處理的要求。
6. 其他專門要求
如用戶單位對安全保密的要求，對使用方便的要求，對可維護性、可補充性、易讀性、可靠性、運行環境可轉換性的特殊要求等。
四、運行環境規定
1. 設備
列出運行該軟件所需要的硬設備，說明其中的新型設備及其專門功能，包括：
- 處理器型號及內存容量；
- 外存容量，聯機或脫機，媒體及其存儲格式，設備的型號及數量；
- 輸入及輸出設備的型號和數量，聯機或脫機；
- 數據通信設備的型號和數量；
- 功能鍵及其他專用硬件。
2. 支持軟件
列出支持系統，包括要用到的操作系統、編譯或匯編程序、測試支持軟件等。
3. 接口
說明該軟件同其他軟件之間的接口、數據通信協議等。
4. 控制
說明控制該軟件的運行的方法和控制信號，并說明這些控制信號的來源。
概要設計說明書
一、引言
1. 編寫目的
說明編寫這份概要說明書的目的，指出預期的讀者。
2. 背景
說明：
- 待開發軟件系統的名稱
- 列出此項目的任務提出者、開發者、用戶、以及將運行該軟件的計算中心
3. 定義
列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組。
4. 參考資料
列出有關的參考文件，如：
- 本項目的經核準的計劃任務書或合同、上級機關的批文；
- 屬于本項目的其他已發表文件；
- 本文件中各處引用的文件、資料，包括所要用到的軟件開發標準；
列出這些文件的標題、文件編號、發表日期、出版單位，說明能夠得到這些文件資料的來源。
二、總體設計
1. 需求規定
說明對本系統的主要輸入輸出項目、處理的功能性能需求，詳細的說明可參考軟件需求說明。
2. 運行環境
簡要說明對本系統的運行環境（包括硬件環境和支持環境）的規定，詳細說明參見軟件需求說明
3. 基本設計概念和處理流程
說明本系統的基本設計概念和處理流程，盡量使用圖表的形式。
4. 結構
用一覽表和框圖的形式，說明本系統的系統元素（各層模塊、子程序、公用程序等）的劃分，概要說明每個系統元素的標識符和功能，分層次地給出各元素之間的控制與被控制關系
5. 功能需求與程序的關系
用一張表說明，各項需求的實現同各塊程序的分配關系。
6. 人工處理過程
說明在本軟件系統的工作過程中，不得不包含的人工處理過程（如果有的話）。
7. 尚未解決的問題
說明在概要設計過程中尚未解決、而設計者認為在系統完成之前必須解決的各個問題。
三、接口設計
1. 用戶接口
說明將向用戶提供的命令和它們的語法結構，以及軟件的回答信息。
2. 外部接口
說明本系統同外界的所有接口的安排，包括軟件與硬件之間的接口，本系統與各支持軟件之間的接口關系。
3. 內部接口
說明本系統內部的各個系統元素之間的接口的安排。
四、運行設計
1. 運行模塊組合
說明對系統施加不同的外界運行控制時，所引起的各種不同的運行模塊組合，說明每種運行所經歷的內部模塊和支持軟件。
2. 運行控制
說明每一種外界的運行控制的方式方法和操作步驟。
3. 運行時間
說明每種運行模塊組合將占用各種資源的時間。
五、系統數據結構設計
1. 邏輯結構設計要點
給出本系統內使用的每個數據結構的名稱、標識符以及它們之中每個數據項、記錄、文卷和系的標識、定義、長度以及它們之間的層次的或表格的相互關系。
2. 物理結構設計要點
給出本系統內使用的每個數據結構中的每個數據項的存儲要求、訪問方法、存取單位、存取的物理關系（索引、設備、存儲區域）、設計考慮和保密條件。
3. 數據結構與程序的關系
說明各個數據結構與訪問這些數據結構的形式。
六、系統出錯處理設計
1. 出錯信息
用一覽表的方式，說明每種可能的出錯或故障情況出現時，系統輸出信息的形式、含義及處理方法。
2. 補救措施
說明故障出現后，可能采取的變通措施，包括：
- 后備技術。說明準備采用的后備技術，當原始系統數據萬一丟失時啟用的副本的建立和啟動的技術，例如，周期性地將磁盤信息記錄到磁帶上，就是對于磁盤媒體的一種后備技術。
- 降效技術。說明準備采用的后備技術，使用另一個效率稍低的系統或方法、來求得所需結果的某些部分。例如，一個自動系統的降效技術，可以是手工操作和數據的人工記錄。
- 恢復及再啟動技術。說明將使用的恢復再啟動技術，使軟件從故障點恢復執行或使軟件從頭開始重新運行的方法。
3. 系統維護設計
說明為了系統維護的方便，而在程序內部設計中做出的安排，包括在程序中專門安排用于系統的檢查與維護的檢測點和專用模塊。
詳細說明設計書
一、引言
1. 編寫目的
說明編寫這份概要說明書的目的，指出預期的讀者。
2. 背景
說明：
- 待開發軟件系統的名稱
- 列出此項目的任務提出者、開發者、用戶、以及將運行該軟件的計算中心
3. 定義
列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組。
4. 參考資料
列出有關的參考文件，如：
- 本項目的經核準的計劃任務書或合同、上級機關的批文；
- 屬于本項目的其他已發表文件；
- 本文件中各處引用的文件、資料，包括所要用到的軟件開發標準；
列出這些文件的標題、文件編號、發表日期、出版單位，說明能夠得到這些文件資料的來源。
二、程序系統的結構
用一系列圖表，列出本程序系統內的每個程序（包括每個模塊和子程序）的名稱、標識符和它們之間的層次結構關系。
三、程序1（標識符）設計說明
1. 程序描述
給出對該程序的簡要描述，主要說明安排設計本程序的目的意義，并且還要說明本程序的特點（如是常駐內存還是非常駐，是否子程序，是可重入的還是不可重入的，有無覆蓋要求，是順序處理還是并發處理等等）。
2. 功能
說明該程序應具有的功能，可采用IPO圖（即輸入-處理-輸出圖）的形式。
3. 性能
說明對該程序的全部性能要求，包括對精度、靈活性和時間特性的要求。
4. 輸入項
給出每個輸入項的特性，包括名稱、標識、數據的類型和格式，數據值的有效范圍，輸入的形式、數量和頻度，輸入媒體，輸入數據的來源和安全保密條件等。
5. 輸出項
給出每個輸出項的特性，包括名稱、標識、數據的類型和格式，數據值的有效范圍，輸出的形式、數量和頻度，輸出媒體，對輸出圖形及符號的說明、安全保密條件等。
6. 算法
詳細說明本程序選用的算法、具體的計算公式和計算步驟。
7. 流程邏輯
用圖表（例如流程圖、判定表等）輔以必要的說明來表示本程序的邏輯流程。
8. 接口
用圖的形式說明本程序隸屬于的上一層模塊及隸屬于本程序的下一層模塊、子程序，說明參數賦值和調用方式，說明與本程序直接關聯的數據結構（數據庫、數據文卷）。
9. 存儲分配
根據需要，說明本程序的存儲分配。
10. 注釋設計
說明準備在本程序中安排的注釋，如：
- 加在模塊首部的注釋；
- 加在各分支點處的注釋；
- 對各變量的功能、范圍、默認條件等所加的注釋；
- 對使用的邏輯所加的注釋等。
11. 限制條件
說明本程序運行中所受到的限制條件。
12. 測試計劃
說明對本程序進行單體測試的計劃，包括對測試的技術要求、輸入數據、預期結果、進度安排、人員職責、設備條件驅動程序及樁模塊等的規定。
13. 尚未解決的問題
說明在本程序的設計中尚未解決、而設計者認為在軟件完成之前應解決的問題。
四、程序2（標識符）設計說明
用類似程序1的方式，說明第2個程序乃至于第n個程序的設計考慮。
總結
以上是生活随笔為你收集整理的【软件工程】软件需求说明书、概要设计说明书、详细设计说明书参考模板的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： Find The Multiple PO
- 下一篇： Vmware由于centos升级内核不可