1.1編寫目的
說明編寫這份詳細設計說明書的目的,指出預期的讀者。
1.2背景
說明:
a.待開發(fā)軟件系統(tǒng)的名稱;
b.本項目的任務提出者、開發(fā)者、用戶和運行該程序系統(tǒng)的計算中心。
1.3定義
列出本文件中用到專門術(shù)語的定義和外文首字母組詞的原詞組。
1.4參考資料
列出有關(guān)的參考資料,如:
a.本項目的經(jīng)核準的計劃任務書或合同、上級機關(guān)的批文;
b.屬于本項目的其他已發(fā)表的文件;
c.本文件中各處引用到的文件資料,包括所要用到的軟件開發(fā)標準。列出這些文件的標題、文件編號、發(fā)表日期和出版單位,說明能夠取得這些文件的來源。
2程序系統(tǒng)的結(jié)構(gòu)
用一系列圖表列出本程序系統(tǒng)內(nèi)的每個程序(包括每個模塊和子程序)的名稱、標識符和它們之間的層次結(jié)構(gòu)關(guān)系。
3程序1(標識符)設計說明
從本章開始,逐個地給出各個層次中的每個程序的設計考慮。以下給出的提綱是針對一般情況的。對于一個具體的模塊,尤其是層次比較低的模塊或子程序,其很多條目的內(nèi)容往往與它所隸屬的上一層模塊的對應條目的內(nèi)容相同,在這種情況下,只要簡單地說明這一點即可。
3.1程序描述
給出對該程序的簡要描述,主要說明安排設計本程序的目的意義,并且,還要說明本程序的特點(如是常駐內(nèi)存還是非常駐?是否子程序?是可重人的還是不可重人的?有無覆蓋要求?是順序處理還是并發(fā)處理卜…..等)。
3.2功能
說明該程序應具有的功能,可采用IPO圖(即輸入一處理一輸出圖)的形式。
3.3性能
說明對該程序的全部性能要求,包括對精度、靈活性和時間特性的要求。
3.4輸人項
給出對每一個輸入項的特性,包括名稱、標識、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入的方式。數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來源和安全保密條件等等。
3.5輸出項
給出對每一個輸出項的特性,包括名稱、標識、數(shù)據(jù)的類型和格式,數(shù)據(jù)值的有效范圍,輸出的形式、數(shù)量和頻度,輸出媒體、對輸出圖形及符號的說明、安全保密條件等等。
3.6算法
詳細說明本程序所選用的算法,具體的計算公式和計算步驟。
3.7流程邏輯
用圖表(例如流程圖、判定表等)輔以必要的說明來表示本程序的邏輯流程。
3.8接口
用圖的形式說明本程序所隸屬的上一層模塊及隸屬于本程序的下一層模塊、子程序,說明參數(shù)賦值和調(diào)用方式,說明與本程序相直接關(guān)聯(lián)的數(shù)據(jù)結(jié)構(gòu)(數(shù)據(jù)庫、數(shù)據(jù)文卷)。
3.9存儲分配
根據(jù)需要,說明本程序的存儲分配。
3.10注釋設計
說明準備在本程序中安排的注釋,如:
a.加在模塊首部的注釋;
b.加在各分枝點處的注釋;對各變量的功能、范圍、缺省條件等所加的注釋;
d.對使用的邏輯所加的注釋等等。
3.11限制條件
說明本程序運行中所受到的限制條件。
3.12測試計劃
說明對本程序進行單體測試的計劃,包括對測試的技術(shù)要求、輸入數(shù)據(jù)、預期結(jié)果、進度安排、人員職責、設備條件驅(qū)動程序及樁模塊等的規(guī)定。
3.13尚未解決的問題
說明在本程序的設計中尚未解決而設計者認為在軟件完成之前應解決的問題。
4 程序2(標識符)設計說明
用類似3的方式,說明第2個程序乃至第N個程序的設計考慮。