軟體工程之— 項目開發文檔(詳細設計說明書)

 

詳細設計說明書

1.引言

1.1編寫目的

    [說明編寫這份詳細設計說明書的目的，指出預期的讀者。]

1.2背景

a. [待開發系統的名稱；]

b. [列出本項目的任務提出者、開發人員、使用者。]

1.3定義

    [列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。]

1.4參考資料

    [列出有關的參考資料。]

2. 系統的結構

    [給出系統的結構框圖，包括軟體結構、硬體結構框圖。用一系列圖表列出系統內的每個模組的名稱、標識符和它們之間的階層關係。]

3．模組1（標識符）設計說明

    [從本章開始，逐個地給出各個層次中的每個模組的設計考慮。以下給出的提綱是針對一般情況的。對於一個具體的模組，尤其是層次比較低的模組或子程式，其很多條目的內容往往與它所隸屬的上一層模組的對應條目的內容相同，在這種情況下，只要簡單地說明這一點即可。]

3.1模組描述

    [給出對該基本模組的簡要描述，主要說明安排設計本模組的目的意義，並且，還要說明本模組的特點。]

3.2功能

    [說明該基本模組應具有的功能。]

3.3效能

    [說明對該模組的全部效能要求。]

3.4輸入項

    [給出對每一個輸入項的特性。]

3.5輸出項

    [給出對每一個輸出項的特性。]

3.6設計方法（演算法）

    [對於軟體設計，應詳細說明本程式所選取用的演算法，具體的計算公式及計算步驟。]

    [對於硬體設計，應詳細說明本模組的設計原理、元器件的選取、各元器件的邏輯關係，所需要的各種協議等。]

3.7流程邏輯

    [用圖表輔以必要的說明來表示本模組的邏輯流程。]

3.8介面

    [說明本模組與其它相關模組間的邏輯串連方式，說明涉及到的參數傳遞方式。]

3.9儲存分配

    [根據需要，說明本模組的儲存分配。]

3.10注釋設計

    [說明安排的程式注釋。]

3.11限制條件

    [說明本模組在運行使用中所受到的限制條件。]

3.12測試計劃

    [說明對本模組進行單體測試的計劃，包括對測試的技術要求、輸入資料、預期結果、進度安排、人員職責、裝置條件、驅動程式及樁模組等的規定。]

3.13尚未解決的問題

    [說明在本模組的設計中尚未解決而設計者認為在系統完成之前應解決的問題。]

4．模組2（標識符）設計說明

    [用類似第3條的方式，說明第2個模組乃至第N個模組的設計考慮。]