詳細設計說明書

2023-01-11 15:27:02 字數 2322 閱讀 7963

版本歷史

目錄1. 引言 4

1.1. 編寫目的 4

1.2. 背景 4

1.3. 範圍 4

1.4. 定義 4

1.5. 參考資料 4

2. 系統的結構 4

2.1. 結構劃分 4

2.2. 層次結構關係 5

3. 全域性資料結構說明 5

3.1. 常量 5

3.2. 變數 5

3.3. 資料結構 5

4. 模組設計 5

4.1. 模組1(識別符號)設計說明 5

4.1.1. 模組描述 6

4.1.2. 功能 6

4.1.3. 效能 6

4.1.4. 輸入項 6

4.1.5. 輸出項 6

4.1.6. 設計方法(演算法) 6

4.1.7. 模組分層設計 6

4.1.8. 資料結構說明 7

4.1.9. 流程邏輯 7

4.1.10. 儲存分配 8

4.1.11. 源程式檔案說明 8

4.1.12. 函式說明 8

4.1.13. 限制條件 8

4.1.14. 測試計畫 8

4.1.15. 尚未解決的問題 8

模組n(識別符號)設計說明 9

說明編寫本軟體詳細設計說明書的目的,指出預期的讀者。

a. 說明待開發系統的名稱。

b. 列出開發此軟體系統任務的提出者、開發者和使用者等。

說明本軟體詳細設計說明書的涉及的內容範圍。

列出本軟體詳細設計說明書中用到的專門術語和外文首字母組詞的原片語。

屬於本專案的其它已發表的檔案。

本檔案中引用的文獻、資料、標準等。

給出系統的結構框圖,包括軟體結構、硬體結構框圖。用一系列圖表列出系統內的給個模組的名稱、識別符號和它們之間的層次結構關係。

用一系列圖表列出本程式系統內的每個模組的名稱、識別符號、功能及其所包含的源程式檔名。

用一系列圖表列出本程式系統內的每個程式(包括每個模組和子程式)之間的層次結構與呼叫關係。

本章說明本程式系統中使用的全域性資料常量、變數和資料結構。

包括資料檔案名稱及其所在目錄,功能說明,具體常量說明等。

包括資料檔案名稱及其所在目錄,功能說明,具體變數說明等。

包括資料結構名稱,功能說明,具體資料結構說明(定義、注釋、取值…)等。

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

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

說明該基本模組應具備的功能。

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

給出每個輸入項的特性。

給出每乙個輸出項的特性。

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

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

描述本程式實體層相關資料實體。

描述本程式控制層相關控制方法。

分別描述控制類、業務類、資料訪問類的方法。

描述系統介面層操作類的方法。

給出本程式中的區域性資料結構說明,包括資料結構名稱,功能說明,具體資料結構說明(定義、注釋、取值…)等。

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

具體說明需要以檔案方式儲存的資料檔名、資料儲存格式、資料項及屬性等。

給出本程式的各源程式檔案的說明,包括源程式檔名稱及其所在目錄,功能說明,包含的前導檔案及函式名稱等。

具體說明本程式中的各個函式,包括函式名稱及其所在檔案,功能,格式,引數,全程變數,區域性變數,返回值,演算法說明,使用約束等。

說明本模組在執行使用中受到的限制條件。

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

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

用類似4.1的方式,說明第2個模組乃至第n個的設計考慮。

附加說明:

編寫文件時,要求具有本規範規定的所有條目。如果某條目無內容可填寫,則填寫「無」,並在可能的情況下說明理由。

詳細設計說明書

會議管理系統 設計人 李靜 設計時間 2014 3 26 本文件定義了cool meeting系統的概要設計,使開發人員初步的了解cool meeting系統的功能內容 功能邊界 開發途徑,執行環境等。系統名稱 cool meeting會議管理系統 以下簡稱coolmeeting系統 本專案是為了在...

詳細設計說明書

1 引言 1 1.1編寫目的 1 1.2專案背景 1 1.3定義 2 1.4參考資料 2 2 總體設計 2 2.1需求概述 2 2.2軟體結構 2 3 程式描述 2 3.1功能 3 3.2效能 3 3.3輸入專案 3 3.4輸出專案 3 3.5演算法 3 3.6程式邏輯 3 3.7介面 3 3.8儲...

詳細設計說明書

1.引言 1.1 編寫目的 闡明編寫詳細設計說明書的目的,指明讀者物件。1.2 專案背景 應包括專案的 委託單位和主管部門等。1.3 定義 列出本文件中用到的專門術語的定義和縮寫詞的原意。1.4 參考資料 可包括 a.經核准的專案計畫任務書 合同或上級機關的批文 b.專案開發計畫 c.需求規格說明書...