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