詳細設計說明書

詳細設計說明書

詳細設計說明書又可稱程式設計說明書。編制目的是說明一個軟體系統各個層次中的每一個程式 (每個模組或子程式)的設計考慮,如果一個軟體系統比較簡單,層次很少,本檔案可以不單獨編寫,有關 內容合併入概要設計說明書

基本介紹

  • 中文名:詳細設計說明書
  • 別稱:又可稱程式設計說明書
  • 使用技巧:對詳細設計說明書的內容要求
  • 說明書:引言
使用技巧,說明書,參考資料,程式注釋,

使用技巧

對詳細設計說明書的內容要求如下:
1 引言
1.1編寫目的
1.2背景
1.3定義
1.4參考資料
2 程式系統的組織結構
3 程式(標識符)設計說明
3.1程式描述
3.2功能
3.3性能
3.4輸入項
3.5輸出項
3.6算法
3.7流程邏輯
3.8接口
3.9存儲分配
3.10注釋設計
3.11限制條件
3.13尚未解決的問題
4 程式2(標識符)設計說明
......

說明書

1引言
1.1編寫目的
說明編寫這份詳細設計說明書的目的,指出預期的讀者。
1.2背景
a.待開發軟體系統的名稱;
b.本項目的任務提出者、開發者、用戶和運行該程式系統的計算中心。
1.3定義
列出本項目中用到專門術語的定義和外文首字母組詞的原詞組。

參考資料

列出有關的參考資料,如:
a.本項目的經核准的計畫任務書或契約、上級機關的批文;
b.屬於本項目的其他已發表的檔案;
c.本檔案中各處引用到的檔案資料,包括所要用到的軟體開發標準。 列出這些檔案的標題、檔案編號、發表日期和出版單位,說明能夠取得這些檔案的來源。
F.2程式系統的結構
用一系列圖表列出本程式系統內的每個程式(包括每個模組和子程式)的名稱、標識符和它們之間 的層次結構關係。
F.3程式1(標識符)設計說明
從本章開始,逐個地給出各個層次中的每個程式的設計考慮。以下給出的提綱是針對一般情況的。 對於一個具體的模組,尤其是層次比較低的模組或子程式,其很多條目的內容往往與它所隸屬的上一層 模組的對應條目的內容相同,在這種情況下,只要簡單地說明這一點即可。
F.3.1程式描述
給出對該程式的簡要描述,主要說明安排設計本程式的目的意義,並且,還要說明本程式的特點(如 是常駐記憶體還是非常駐?是否子程式?是可重入的還是不可重入的?有無覆蓋要求?是順序處理還是並發 處理卜…..等)。
F.3.2功能
說明該程式應具有的功能,可採用IPO圖(即輸入一處理一輸出圖)的形式。
F.3.3性能
說明對該程式的全部性能要求,包括對精度、靈活性和時間特性的要求。
F.3.4輸入項
給出對每一個輸入項的特性,包括名稱、標識、數據的類型和格式、數據值的有效範圍、輸入的方式。 數量和頻度、輸入媒體、輸入數據的來源和安全保密條件等等。
F. 3. 5輸出項
給出對每一個輸出項的特性,包括名稱、標識、數據的類型和格式,數據值的有效範圍,輸出的形式、 數量和頻度,輸出媒體、對輸出圖形及符號的說明、安全保密條件等等。
F.3.6算法
詳細說明本程式所選用的算法,具體的計算公式和計算步驟。
F.3.7流程邏輯
用圖表(例如流程圖、判定表等)輔以必要的說明來表示本程式的邏輯流程。
F.3.8接口
用圖的形式說明本程式所隸屬的上一層模組及隸屬於本程式的下一層模組、子程式,說明參數賦值和調用方式,說明與本程式相直接關聯的數據結構(資料庫、數據文卷)。
F.3.9存儲分配
根據需要,說明本程式的存儲分配。
F.3.10注釋設計

程式注釋

a. 加在模組首部的注釋;
b.加在各分枝點處的注釋;
c. 對各變數的功能、範圍、預設條件等所加的注釋;
d.對使用的邏輯所加的注釋等等。
F.3.11限制條件
說明本程式運行中所受到的限制條件。
F.3.12測試計畫
說明對本程式進行單體測試的計畫,包括對測試的技術要求、輸入數據、預期結果、進度安排、人員職責、設備條件驅動程式及樁模組等的規定。
F.3.13尚未解決的問題
說明在本程式的設計中尚未解決而設計者認為在軟體完成之前應解決的問題。
F.4程式2(標識符)設計說明
用類似F.3的方式,說明第2個程式乃至第N個程式的設計考慮。
......

相關詞條

熱門詞條

聯絡我們