詳細設計說明書編寫規範 國標

2022-08-19 05:48:03 字數 1883 閱讀 4124

<專案名稱>

詳細設計說明書

作者完成日期

簽收人簽收日期

修改情況記錄:

目錄1 引言 1

1.1 編寫目的 1

1.2 背景 1

1.3 定義 1

1.4 參考資料 1

2 程式系統的結構 1

3 程式1(識別符號)設計說明 2

3.1 程式描述 2

3.2 功能 2

3.3 效能 2

3.4 輸入項 2

3.5 輸出項 2

3.6 演算法 3

3.7 流程邏輯 3

3.8 介面 3

3.9 儲存分配 3

3.10 注釋設計 3

3.11 限制條件 3

3.12 測試計畫 3

3.13 尚未解決的問題 4

4 程式2(識別符號)設計說明 4

說明編寫這份詳細設計說明書的目的,指出預期的讀者範圍。

說明:a. 待開發的軟體系統的名稱;

b. 列出本專案的任務提出者、開發者、使用者以及將執行該項軟體的單位。

列出本檔案中用到的專門術語的定義和縮寫詞的原片語。

列出要用到的參考資料,如:

a. 本專案的經核准的計畫任務書或合同、上級機關的批文;

b. 屬於本專案的其他已發表的檔案;

c. 本檔案中各處引用的檔案、資料,包括所要用到的軟體開發標準。

列出這些檔案的標題、檔案編號、發表日期和出版單位,說明能夠得到這些檔案資料的**。

用一系列圖表列出本程式系統內的每個程式(包括每個模組和子程式)的名稱、識別符號和它們之間的層次結構關係。

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

給出對該程式的簡要描述,主要說明安排設計本程式的目的意義,並且,還要說明本程式的特點(如是常駐記憶體還是非常駐?是否子程式?是可重入的還是不可重入的?

有無覆蓋要求?是順序處理還是併發處理?.....等)。

說明該程式應具有的功能,可採用ipo圖(即輸入-處理-輸出圖)的形式。

說明對該程式的全部效能要求,包括對精度、靈活性和時間特性的要求。

給出對每乙個輸入項的特性,包括名稱、標識、資料的型別和格式、資料值的有效範圍、輸入的方式、數量和頻度、輸入**、輸入資料的**和安全保密條件等等。

給出對每乙個輸出項的特性,包括名稱、標識、資料的型別和格式、資料值的有效範圍、輸出的形式、數量和頻度、輸出**、對輸出圖形及符號的說明、安全保密條件等等。

詳細說明本程式所選用的演算法,具體的計算公式和計算步驟。

用圖表(例如流程流程圖、判定表等)輔以必要的說明來表示本程式的邏輯流程。

用圖的形式說明本程式所隸屬的上一層模組及隸屬於本程式的下一層模組、子程式,說明引數賦值和呼叫方式,說明與本程式相直接關聯的資料結構(資料庫、資料文捲)。

根據需要,說明本程式的儲存分配。

說明準備在本程式中安排的注釋,如:

a. 加在模組首部的注釋;

b. 加在各分枝點處的注釋;

c. 對各變數的功能、範圍、預設條件等所加的注釋;

d. 對使用的邏輯所加的注釋等等。

說明本程式執行中所受到的限制條件。

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

說明在本程式的設計中尚未解決而設計者認為在軟體完成之前應解決的問題。

用類似第3章的方式,說明第2個程式乃至第n個程式的設計考慮。

......

資料庫設計說明書編寫規範國標

專案名稱 資料庫設計說明書 作者完成日期 簽收人簽收日期 修改情況記錄 目錄1 引言 1 1.1 編寫目的 1 1.2 背景 1 1.3 定義 1 1.4 參考資料 1 2 外部設計 1 2.1 識別符號和狀態 1 2.2 使用它的程式 2 2.3 約定 2 2.4 專門指導 2 2.5 支援軟體 ...

詳細設計說明書和編寫提示

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

詳細設計說明書

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