編寫詳細設計說明書

2021-08-31 13:00:21 字數 2538 閱讀 1824

詳細設計

專案開發流程中有很重要的一步是編寫詳細設計說明書。根據個人多年編寫詳細設計的經驗對編寫詳細設計進行簡單總結,希望對各位有所幫助,詳細設計文件中涉及到的資料流程圖、業務流程圖、用例圖、類圖、介面原型圖等用到畫圖工具的,以後如果有時間我會進行補充說明。

詳細設計說明書的任務

詳細設計

的主要任務

是設計每個模組的實現演算法、所需的區域性資料結構。

簡單的說就是讓乙個程式設計師拿到你的詳細設計就可以開發。

詳細設計主要內容

一般包括6章一、

引言 二、概述 三、

總體結構說明 四、

資料模型設計 五、

功能實現說明 六、

介面說明

一、二、三章在這裡就不再詳述,具體專案具體描述;四五六章節可視具體情況組織在一起編寫。

現在詳細說一下第五章功能實現說明。  

5功能實現說明

5.1功能模組名稱

【功能概述、功能分解(結合用例圖、**進行說明)】

5.2.1資料流程圖

【資料流程圖 並加以說明,一般用visio工具畫,一定要屢清每個模組的資料流向,從哪兒到哪兒,做怎樣處理等等】

5.2.2業務流程圖

【利用工具畫出該模組的業務流程圖,如果業務流程比較複雜要加以說明】

5.2.3實現說明

【此部分一般包括四部分】

1、 功能定義

【對該功能進行概述】

2、 處理流程

【編寫該模組的處理流程,要有條理的寫出自己的處理思路】

3、 業務規則

【簡單描述該模組是按照什麼業務規則進行實現的,也可以說簡單需求】

4、 其他說明

【其他說明】

5.2.4程式設計

【此部分就涉及到偽**的編寫了,包含的內容比較多,是與實現**編寫最相近的一步,大概包括以下幾部分內容】

1、   目標檔案定義(結合類圖、**,展現該模組實現的設計框架,簡單的說即要表明都有什麼類,這些類的定義主要是為實現何種功能)

2、   功能定義(對每個類中每個方法加以說明)

a)         輸入輸出(最好以**形式)

b)         程式描述(編寫偽**,體現設計思路,包括異常說明,日誌處理等)

c)         介面定義

d)         尚未解決的問題(此處寫開發之前應該明確但暫時未明確的問題) 1

引言. 1

1.1編寫目的. 1

1.2適用範圍. 1

1.3術語和縮寫. 1

1.4參考資料. 2

2概述. 2

2.1系統概述. 2

2.2系統功能定義. 2

3總體結構說明. 2

3.1系統結構. 2

3.1.1

系統內外部關係圖. 2

3.1.2

功能模組簡要說明. 3

3.1.3

依賴的外部介面. 3

3.1.4

對外提供的介面. 3

3.2模組程式構件結構圖. 3

4資料模型設計. 4

4.1邏輯實體模型. 4

4.2表結構(物理設計). 7

4.2.1

表彙總. 7

4.2.2

資料字典

. 10

4.2.31

許可權控制模組明細表

. 36

4.3檢視列表

. 38

4.4關係清單

. 38 5

功能實現說明

. 40

5.1功能模組名稱

. 41

5.2.1

資料流程圖

. 81

5.2.2

實現說明

. 84

5.2.3

業務流程圖

. 93

5.2.4

程式設計

. 98 6

介面實現說明

. 164

6.1功能模組名稱

. 164

6.1.1

總體介面結構(業務操作區)說明

. 164

6.1.2

模組1

164

6.1.3

模組2

165

詳細設計說明書

詳細設計說明書 1 引言 1.1 編寫目的 闡明編寫詳細設計說明書的目的,指明讀者物件。1.2 專案背景 應包括專案的 和主管部門等。1.3 定義 列出本文件中所用到的專門術語的定義和縮寫詞的願意。1.4 參考資料 列出有關資料的作者 標題 編號 發表日期 出版單位或資料 專案經核准的計畫任務書 合...

詳細設計說明書

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

詳細設計說明書

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