目錄
編制概要設計說明書的內容,內容如下:
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系統維護設計
編寫概要
(參考件)
引言及背景
1 引言
1.1編寫目的
說明編寫這份概要設計說明書的目的,指出預期的讀者。
1.2背景
說明:
a.待開發軟體系統的名稱;
b.列出此項目的任務提出者、開發者、用戶以及將運行該軟體的計算站(中心)。
1.3定義
列出本檔案中用到的專門術語的定義和外文首字母組詞的原詞組。
1.4參考資料
列出有關的參考檔案,如:
a.本項目的經核准的計畫任務書或契約,上級機關的批文;
b.屬於本項目的其他已發表檔案;
c.本檔案中各處引用的檔案、資料,包括所要用到的軟體開發標準。 列出這些檔案的標題、檔案編號、發表日期和出版單位,說明能夠得到這些檔案資料的來源。
結構及流程
2總體設計
2.1需求規定
說明對本系統的主要的輸入輸出項目、處理的功能性能要求,詳細的說明可參見附錄C。
2.1.1系統功能
2.1.2系統性能
2.1.2.1精度
2.1.2.2時間特性要求
2.1.2.3可靠性
2.1.2.4靈活性
2.1.3輸入輸出要求
2.1.4數據管理能力要求
2.1.5故障處理要求
2.1.6其他專門要求
2.2運行環境
簡要地說明對本系統的運行環境(包括硬體環境和支持環境)的規定,詳細說明參見附錄C。
2.2.1設備 列出運行該軟體所需要的硬設備。說明其中的新型設備及其專門功能。
2.2.2支持軟體
列出支持軟體,包括要用到的作業系統、編譯(或彙編)程式、測試支持軟體等。
2.2.3接口
說明該系統同其他系統之間的接口、數據通信協定等
2.2.4控制
說明控制該系統的運行的方法和控制信號,並說明這些控制信號的來源。
2.3基本設計概念和處理流程
說明本系統的基本設計概念和處理流程,儘量使用圖表的形式。
2.4結構
用一覽表及框圖的形式說明本系統的系統元素(各層模組、子程式、公用程式等)的劃分,扼要說明每個系統元素的標識符和功能,分層次地給出各元素之間的控制與被控制關係.
2.5功能需求與程式的關係
本條用一張矩陣圖說明各項功能需求的實現同各塊程式的分配關係:E.2.7E.2.7..
[系統模組1] | [系統模組2] | [……] | [系統模組m] | |
[功能需求1] | √ | |||
[功能需求2] | √ | |||
[┇] | ||||
[功能需求n] | √ | √ |
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數據結構與程式的關係
說明各個數據結構與訪問這些數據結構的形式:
[程式1] | [程式2] | [……] | [程式m] | |
[數據結構1] | √ | |||
[數據結構2] | √ | √ | ||
┇ | ||||
[數據結構n] | √ | √ |
出錯處理機制
6系統出錯處理設計
6.1出錯信息
用一覽表的方式說明每種可能的出錯或故障情況出現時,系統輸出信息的形式、含意及處理方法。
6.2補救措施
說明故障出現後可能採取的變通措施,包括:
a.後備技術說明準備採用的後備技術,當原始系統數據萬一丟失時啟用的副本的建立和啟動的技術,例如周期性地把磁碟信息記錄到磁帶上去就是對於磁碟媒體的一種後備技術;
b.降效技術說明準備採用的後備技術,使用另一個效率稍低的系統或方法來求得所需結果的某些部分,例如一個自動系統的降效技術可以是手工操作和數據的人工記錄;
c.恢復及再啟動技術說明將使用的恢復再啟動技術,使軟體從故障點恢復執行或使軟體從頭開始重新運行的方法。
6.3系統維護設計
說明為了系統維護的方便而在程式內部設計中作出的安排,包括在程式中專門安排用於系統的檢查與維護的檢測點和專用模組。 各個程式之間的對應關係,可採用如下的矩陣圖的形式;