模板一(軟件開發文檔模板)
1引言
1.1編寫目的
1.2背景
1.3定義
1.4參考資料
2總體設計
2.1需求規定
2.2運行環境
2.3基本設計概念和處理流程
2.4結構
2.5功能器求與程序的關系
2.6人工處理過程
2.7尚未問決的問題
3接口設計
3.1用戶接口
3.2外部接口
3.3內部接口
4運行設計
4.1運行模塊組合
4.2運行控制
4.3運行時間
5系統數據結構設計
5.1邏輯結構設計要點
5.2物理結構設計要點
5.3數據結構與程序的關系
6系統出錯處理設計
6.1出錯信息
6.2補救措施
6.3系統維護設計
模板二(ISO9001標準文檔模版)
第1章 引言
1.1 編寫目的
1.2 術語
1.3 參考文獻
第2章 系統概述
2.1 系統說明
2.2 系統任務
2.2.1 系統目標
2.2.2 運行環境
2.2.3 與其它系統關系
2.3 需求規定
2.3.1 功能需求
2.3.2 性能需求
2.3.3 數據要求
2.3.4 其它
第3章 總體設計
3.1 系統物理結構
3.1.1 系統流程圖
3.1.2 設備清單
3.2 軟件結構圖
3.2.1 模塊結構圖
3.2.2 模塊清單
第4章 模塊功能描述
4.1 模塊1(標識符) 功能
4.2 模塊2 (標識符)功能
第5章 接口設計
5.1 用戶界面
5.2 硬件接口
5.3 軟件接口
5.4 通信接口
第6章 數據結構設計
6.1 數據結構1 (標識符)
6.1.1 結構屬性
6.1.2 邏輯結構
6.1.3 物理結構
6.1.4 數據元素
6.2 數據結構2 (標識符)
第7章 運行設計
7.1 運行1
7.1.1 運行模塊組合運行名稱
7.1.2 運行控制操作
7.1.3 運行時間
7.2 運行2
第8章 系統安全
8.1 系統安全
8.2 數據安全
8.3 后備與恢復
8.4 出錯處理
8.5 計算機病毒的防治措施
第9章 功能需求、數據結構和模塊
9.1 功能需求與模塊關系
9.2 數據結構與模塊關系
模板三(概要設計說明書)
1 引言
1.1 寫目的:闡明編寫概要設計說明書的目的,指明讀者對象。
1.2 項目背景:應包括
● 項目的委托單位、開發單位和主管部門
● 該軟件系統與其他系統的關系。
1.3 定義:列出本文檔中所用到的專門術語的定義和縮寫詞的愿意。
1.4 參考資料:
● 列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源
●項目經核準的計劃任務書、合同或上級機關的批文;項目開發計劃;需求規格說明書;測試計劃(初稿);用戶操作手冊
● 文檔所引用的資料、采用的標準或規范。
2 任務概述
2.1 目標
2.2 需求概述
2.3 條件與限制
3 總體設計
3.2 總體結構和模塊外部設計
3.3 功能分配:表明各項功能與程序結構的關系。
4 接口設計
4.1 外部接口:包括用戶界面、軟件接口與硬件接口。
4.2 內部接口:模塊之間的接口。
5 數據結構設計
6 邏輯結構設計
所有文檔的統一封面格式如下頁所示。
7 物理結構設計
8 數據結構與程序的關系
9 運行設計
9.1 運行模塊的組合
9.2 運行控制
9.3 運行時間
10 出錯處理設計
10.1 出錯輸出信息
10.2 出錯處理對策:如設置后備、性能降級、恢復及再啟動等。
11 安全保密設計
12 維護設計
說明為方便維護工作的設施,如維護模塊等。
模板四(概要編寫規范)
“概要設計說明書”編寫規范
軟件的概要設計又稱為軟件系統(程序系統)的設計,本文件應說明軟件系統即程序系統設計的總體考慮,包括系統的基本處理流程、軟件系統的組織結構、模塊劃分、功能分配、數據結構、接口、運行、 出錯處理和系統維護等方面的設計,為詳細設計提供基礎。
1 引言
1.1 編寫目的
說明編寫本設計說明書的目的,指出預期的讀者。
1.2 背景
a. 說明待開發軟件系統的名稱。
b. 列出開發此軟件系統的提出者、開發者、和用戶。
1.3 基線
說明本系統設計的設計基線。
1.4 范圍
說明本設計說明書所涉及的設計內容范圍。
1.5 定義
列出本設計說明書中用到的專門術語和外文字母組詞的原詞組。
1.6 參考資料
a. 屬于項目的其他已發表的文件;
b. 本設計說明書中引用到的文件、資料,包括所用到的軟件開發標準。
列出這些文件資料的標題、編號、發表日期、出版單位和查找來源。
2 總體設計
2.1 概述
2.1.1 需求規定
說明本系統主要的輸入、處理、輸出的功能和性能要求等。
2.2.2 運行環境
說明本系統運行的硬件環境和支持環境。
2.2 設計
2.2.1 設計構思
說明對本系統設計的構思、采用的關鍵技術、主要算法和關鍵數據結構。
2.2.2 系統流程
a. 用流程圖示出本系統的主要控制流程和處理流程;
b. 用流程圖示出本系統主要的數據通路,并說明處理的主要階段。
2.2.3 結構設計
a. 系統元素
確定本系統的元素及其功能,用一覽表說明本系統的系統元素(各層模塊、子程序、公用程序等)的劃分,按層次給出它們的標識符和功能。
b. 系統層次結構
用框圖分層次地給出各個系統元素之間的控制和被控制的關系。
2.2.4 功能需求與程序的關系
用功能需求與程序的矩陣圖表形式 ,示出各項功能的實現與各系統元素之間的分配關系。
3 系統數據結構設計
3.1 數據結構
列出本系統所使用的主要數據結構,包括名稱、標識符及數據項等。
3.2 數據結構與系統元素之間的關系
用數據結構與系統元素之間的矩陣圖表形式,示出各個數據結構與訪問這些數據結構的系統元素之間的關系。
4 接口設計
4.1 用戶接口
說明本系統向用戶提供的命令、語法結構及系統回答信息等。
4.2 外部接口
說明本系統的軟件同硬件和支持軟件之間的接口。
4.3 內部接口
說明本系統內部相關模塊之間的接口。
5 運行設計
5.1 系統初始化
說明本系統初始化過程。
5.2 運行模塊組合
說明本系統每項外界運行需經過哪些內部模塊的組合和支持軟件。
5.3 運行控制
說明每項外界運行的控制方式、方法和操作步驟。
5.4 運行時間
說明每項運行模塊組合預計占用各種資源的時間。
5.5 運行安全
說明系統安全運行的控制。
6 信息結構設計(當有相關需求或軟件規格定義有要求時)
按邏輯結構和物理結構給出本軟件有關信息的設計要點。
6.1 邏輯結構設計
6.1.1 圖形設計
6.1.2 中文(包括單個漢字、短語、詞組。)設計
6.2 物理結構設計
6.2.1 圖形設計
6.2.2 中文(包括單個漢字、短語、詞組。)設計
6.3 信息結構與程序的關系
用信息結構與系統元素之間的矩陣圖表形式,示出各個信息結構與訪問這些信息結構的系統元素之間的關系。
7 出錯處理和維護
7.1 出錯信息
用一覽表列出本系統各種可能出錯或故障的信息形式及其含義。
7.2 補救措施
說明系統故障出現后可能采取的變通措施,包括:
a. 后備技術——當系統原始數據一旦丟失時,啟用副本的建立和啟動技術;
b. 降效技術——使用另一效率稍低的方法以求得所需結果的某些部份,如手工操作和人工記錄數據;
c. 恢復及再啟動技術——讓系統從故障點恢復執行或系統從新啟動運行的方法等。
7.3 系統維護
說明專門安排用于系統檢測與維護的檢測點和系統檢測維護的專用模塊等。
8 尚待解決的問題
說明本設計中尚未解決而系統完成之前應該解決的問題。
附加說明:
* 本規范根據國家標準GB/T 8566—1995的規定,參照國家標準GB 8567—88 而制定;
* 編寫本文檔時,要求具有本規范規定的所有條目。如果某條目內容在其他地方已說明或無內容可填寫,應聲明或填寫“無內容可填寫” ,并在可能的情況下說明理由。
* 編制文檔時,文檔排印格式按“文檔排版印刷格式約定”編制。