“概要設計說明書”編寫規範
軟體的概要設計又稱為軟體系統(程式系統)的設計,本檔案應說明軟體系統即程式系統設計的總體考慮,包括系統的基本處理流程、軟體系統的組織結構、子產品劃分、功能配置設定、資料結構、接口、運作、出錯處理和系統維護等方面的設計,為詳細設計提供基礎。
1 引言
1.1 編寫目的
說明編寫本設計說明書的目的,指出預期的讀者
1.2 背景
a. 說明待開發軟體系統的名稱
b. 列出開發此軟體系統的提出者、開發者、和使用者
1.3 基線
說明本系統設計的設計基線
1.4 範圍
說明本設計說明書所涉及的設計内容範圍
1.5 定義
列出本設計說明書中用到的專門術語和外文字母組合詞的原詞組
1.6 參考資料
a. 屬于項目的其他已發表的檔案
b. 本設計說明書中引用到的檔案、資料,包括所用到的軟體開發标準
列出這些檔案資料的标題、編号、發表日期、出版機關和查找來源
2 總體設計
2.1 概述
2.1.1 需求規定
說明本系統主要的輸入、處理、輸出的功能和性能要求等
2.1.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.3 資訊結構與程式的關系
用資訊結構與系統元素之間的矩陣圖表形式,示出各個資訊結構與通路這些資訊結構的系統元素之間的關系
7 出錯處理和維護
7.1 出錯資訊
用一覽表列出本系統各種可能出錯或故障的資訊形式及其含義
7.2 補救措施
說明系統故障出現後可能采取的變通措施,包括:
a. 後備技術——當系統原始資料一旦丢失時,啟用副本的建立和啟動技術
b. 降效技術——使用另一效率稍低的方法以求得所需結果的某些部分,如手工操作和人工記錄資料
c. 恢複及再啟動技術——讓系統從故障點恢複執行或系統重新啟動運作的方法等
7.3 系統維護
說明專門安排用于系統檢測與維護的檢測點和系統檢測維護的專用子產品等
8 尚待解決的問題
說明本設計中尚待解決而系統完成之前應該解決的問題
附加說明:
- 本規範根據國家标準GB/T 8566-1995的規定,參照國家标準GB 8567-88而制定
- 編寫本文檔時,要求具有本規範規定的所有條目。如果某條目内容在其他地方已說明或無内容可填寫,應聲明或填寫“無内容可填寫”,并在可能的情況下說明理由
- 編制文檔時,文檔排印格式按“文檔排版印刷格式約定”編制