軟件詳細設(shè)計文檔模板

軟件詳細設(shè)計文檔模板（最全面）

版

密

文檔編一

級

本-商密A

號

項目名

研發(fā)生產(chǎn)中心Xx系統(tǒng)

稱

項目來

源

Xxx系統(tǒng)

詳細設(shè)計說明書

（內(nèi)部資料請勿外傳）

編寫:日期:

檢查:日期:

審核:日期:

批準:日期:

XX公司

1/21

軟件詳細設(shè)計文檔模板（最全面）

文檔變更記錄

版本

序號變更（+/-）說明作者日期批準

號

1

2

目錄

1.引言4

1.1編寫目的和范圍4

1.2術(shù)語表4

1.3參考資料5

1.4使用的文字處理和繪圖工具5

2.全局數(shù)據(jù)結(jié)構(gòu)說明8

2/21

軟件詳細設(shè)計文檔模板（最全面）

2.1常量8

2.2變量9

2.3數(shù)據(jù)結(jié)構(gòu)9

3.模塊設(shè)計11

3.1用例圖11

3.2功能設(shè)計說明12

3.2.1模塊112

3.2.2模塊213

4.接口設(shè)計15

4.1內(nèi)部接口15

4.2外部接口15

4.2.1接口說明15

4.2.2調(diào)用方式15

5.數(shù)據(jù)庫設(shè)計16

6.系統(tǒng)安全保密設(shè)計16

6.1說明16

6.2設(shè)計16

6.2.1數(shù)據(jù)傳輸部分16

6.2.2IP過濾分部16

6.2.3身份驗證部分17

7.系統(tǒng)性能設(shè)計17

8.系統(tǒng)出錯處理17

3/21

軟件詳細設(shè)計文檔模板（最全面）

1.引言

1.1背景

此文檔的背景

1.2編寫目的和范圍

說明寫這份詳細設(shè)計說明書的目的。

本詳細設(shè)計說明書編寫的目的是說明程序模塊的設(shè)計考慮，包括

程序描述、輸入/輸出、算法和流程邏輯等，為軟件編程和系統(tǒng)維護

提供基礎(chǔ)。本說明書的預(yù)期讀者為系統(tǒng)設(shè)計人員、軟件開發(fā)人員、軟

件測試人員和項目評審人員。

1.3術(shù)語表

定義系統(tǒng)或產(chǎn)品中涉及的重要術(shù)語，為讀者在閱讀文檔時提供必

要的參考信息。

序術(shù)語或縮略語說明性定義

號

1PMProjectManager,項目經(jīng)理

2

4/21

軟件詳細設(shè)計文檔模板（最全面）

1.4參考資料

列出有關(guān)資料的名稱、作者、文件編號或版本等。參考資料包括:

a.需求說明書、架構(gòu)設(shè)計說明書等；

b.本項目的其他已發(fā)表的文件；

c.引用文件、資料、軟件開發(fā)標準等。

資料名稱作者文件編號、版資料存放地

,本點

1.5使用的文字處理和繪圖工具

文字處理軟件：[編寫設(shè)計文檔使用的文字處理軟件，如

RedOffice]

繪圖工具：[使用的UML工具，如Rose、Jude、Visio]

5/21

軟件詳細設(shè)計文檔模板（最全面）

2.設(shè)計概述

2.1任務(wù)和目標

2.1.1需求概述

2.1.2運行環(huán)境概述

2.1.3條件與限制

2.1.4詳細設(shè)計方法和工具

3.系統(tǒng)詳細需求分析

主要對系統(tǒng)級的需求進行分析。首先應(yīng)對需求分析提出的企業(yè)需

求進一步確認，并對由于情況變化而帶來的需求變化進行較為詳細的

分析。

6/21

軟件詳細設(shè)計文檔模板（最全面）

3.1詳細需求分析

3.1.1詳細功能需求分析

3.1.2詳細性能需求分析

3.1.3詳細資源需求分析

3.1.4詳細接口需求分析

3.1.5詳細系統(tǒng)運行環(huán)境及限制條件分析

4.總體方案確認

著重解決系統(tǒng)總體結(jié)構(gòu)確認及界面劃分問題。

4.1系統(tǒng)總體結(jié)構(gòu)確認

對系統(tǒng)組成、邏輯結(jié)構(gòu)及層次進行確認，對應(yīng)用系統(tǒng)、支撐系統(tǒng)

及各自實現(xiàn)的功能進行確認，細化集成設(shè)計及系統(tǒng)工作流程，糊感

注意因軟件的引進造成的系統(tǒng)本身結(jié)構(gòu)和公司其他系統(tǒng)的結(jié)構(gòu)變化。

包括：

7/21

軟件詳細設(shè)計文檔模板（最全面）

4.1.1系統(tǒng)組成、邏輯結(jié)構(gòu)及層次確認

4.1.2應(yīng)用系統(tǒng)結(jié)構(gòu)確認

4.1.3支撐系統(tǒng)結(jié)構(gòu)確認

4.1.4系統(tǒng)集成確認

4.1.5系統(tǒng)工作流程確認

4.2系統(tǒng)詳細界面劃分

4.2.1應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細界面劃分

應(yīng)用系統(tǒng)與支撐系統(tǒng)之間的界面包括系統(tǒng)主服務(wù)器與其他服務(wù)器

的服務(wù)范圍及訪問方式，網(wǎng)絡(luò)及數(shù)據(jù)庫對應(yīng)用系統(tǒng)的支撐方式全局數(shù)據(jù)

4.2.2系統(tǒng)內(nèi)部詳細界面劃分

系統(tǒng)各功能之間的界面包括覆蓋范圍，模塊間功能調(diào)用涉及到的

系統(tǒng)模塊及方法，全局數(shù)據(jù)格式，系統(tǒng)性能要求等。

5.全局數(shù)據(jù)結(jié)構(gòu)說明

本章說明本程序系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。

5.1常量

包括數(shù)據(jù)文件名稱及其所在目錄，功能說明，具體常量說明等。

8/21

軟件詳細設(shè)計文檔模板（最全面）

5.2變量

本章說明本程序系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。

5.3數(shù)據(jù)結(jié)構(gòu)

包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋、

取值）等。

6,系統(tǒng)詳細設(shè)計

6.1功能結(jié)構(gòu)圖

6.2系統(tǒng)結(jié)構(gòu)設(shè)計及子系統(tǒng)劃分

對系統(tǒng)的組成及邏輯結(jié)構(gòu)進行設(shè)計前確認。

劃分系統(tǒng)功能模塊或子系統(tǒng)（如果有或者有必要，特別是大型的

軟件系統(tǒng)X

6.3系統(tǒng)功能模塊詳細設(shè)計

按結(jié)構(gòu)化設(shè)計方法，在系統(tǒng)功能逐層分解的基礎(chǔ)上，對系統(tǒng)各功

能模塊或子系統(tǒng)進行設(shè)計。此為詳細設(shè)計的主要部分之一。

用層次圖描述系統(tǒng)的總體結(jié)構(gòu)、功能分解及各個模塊之間的相互

調(diào)用關(guān)系和信息交互，用IPO圖或其他方法描述各模塊完成的功能。

以上建議采用HIPO圖進行功能分解與模塊描述，更高的要求建議采

用IDEFO方法進行功能模型設(shè)計。

詳細設(shè)計應(yīng)用系統(tǒng)的各個構(gòu)成模塊完成的功能及其相互之間的關(guān)

9/21

軟件詳細設(shè)計文檔模板（最全面）

系，用IPO或結(jié)構(gòu)圖描述各模塊的組成結(jié)構(gòu)、算法、模塊間的接口關(guān)

系，以及需求、功能和模塊三者之間的交叉參照關(guān)系。

每個模塊的描述說明可參照以下格式：

模塊編號：

模塊名稱：

輸入：

處理：

算法描述：

輸出：

其中處理和算法描述部分主要采用偽碼或具體的程序語言完成。

對詳細設(shè)計更高的要求建議用IDEFO圖進行各功能模塊的設(shè)計。

如果對軟件需進行二次開發(fā)（包括功能擴展、功能改造、用戶界

面改造等）則相應(yīng)的設(shè)計工作應(yīng)該設(shè)立子課題完成。

6.4系統(tǒng)界面詳細設(shè)計

系統(tǒng)界面說明應(yīng)用系統(tǒng)軟件的各種接口整。個系統(tǒng)的其他接口如

系統(tǒng)硬件接口、通訊接口等）在相應(yīng)的部分說明。

6.4.1外部界面設(shè)計

根據(jù)系統(tǒng)界面劃分進行系統(tǒng)外部界面設(shè)計，對系統(tǒng)的所有外部接

口（包括功能和數(shù)據(jù)接口）進行設(shè)計。

10/21

軟件詳細設(shè)計文檔模板（最全面）

6.4.2內(nèi)部界面設(shè)計

設(shè)計系統(tǒng)內(nèi)部各功能模塊間的調(diào)用關(guān)系和數(shù)據(jù)接口。

6.4.3用戶界面設(shè)計

規(guī)定人機界面的內(nèi)容、界面風(fēng)格、調(diào)用方式等，包括所謂的表單

設(shè)計、報表設(shè)計和用戶需要的打印輸出等設(shè)計此。部分內(nèi)容可能比較多。

7.開發(fā)和測試生產(chǎn)環(huán)境說明

7.1開發(fā)環(huán)境

7.2測試及產(chǎn)品環(huán)境

-Developmentevnironment:programminglanuague,database

Vs2010-svn-iss6.1+-mysql/sqlserver2005/2008-.net

framwork4.0-Testing&productionenvironment:OS,database

-.netframwork4.0

Windwos2003,iis6.0,MySQL,

8.模塊設(shè)計

8.1用例圖

11/21

軟件詳細設(shè)計文檔模板（最全面）

8.2功能設(shè)計說明

8.2.1模塊1

模塊1主要分為以下幾個子模塊子:懶1、子模塊2和子模塊N。

821,1子模塊1

8.2,1.1,1設(shè)計圖

8.2,1,1.2功能描述

簡要描述子模塊1的業(yè)務(wù)功能。

8.2,1.1.3輸入數(shù)據(jù)

詳細描述用戶輸入的數(shù)據(jù)（包括任何輸入設(shè)備）以及這些數(shù)據(jù)的有

效性檢驗規(guī)則。

詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條

件。

8.2,1.1.4輸出數(shù)據(jù)

詳細描述子功能1所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。

8.2,1,1.5業(yè)務(wù)算法和流程

從業(yè)務(wù)角度詳細描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流

程。

12/21

軟件詳細設(shè)計文檔模板（最全面）

8.2,1,1.6數(shù)據(jù)設(shè)計

給出本程序中的局部數(shù)據(jù)結(jié)構(gòu)說明，包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說

明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋設(shè)計、取值）等。相關(guān)數(shù)據(jù)庫表，

數(shù)據(jù)存儲設(shè)計（具體說明需要以文件方式保存的數(shù)據(jù)文件名數(shù)據(jù)存儲

依wwito

8.2,1,1,7源程序文件說明

給出本程序的各源程序文件的說明，包括源程序文件名稱及其所

在目錄，功能說明，包含的前導(dǎo)文件及函數(shù)名稱等。

8.2,1.1,8函數(shù)說明

具體說明本程序中的各個函數(shù)，包括函數(shù)名稱及其所在文件，功

能，格式，參數(shù)，全局變量，局部變量，返回值，算法說明，使用約

束等。

8.2,1,1.9限制條件

8.2,1.1.10其他說明

8.2.2模塊2

模塊1主要分為以下幾個子模塊子:模臾I、子模塊2和子模塊N。

8221子模塊1

8.2,2.1,1設(shè)計圖

13/21

軟件詳細設(shè)計文檔模板（最全面）

.2功能描述

簡要描述子模塊1的業(yè)務(wù)功能。

.3輸入數(shù)據(jù)

詳細描述用戶輸入的數(shù)據(jù)（包括任何輸入設(shè)備）以及這些數(shù)據(jù)的有

效性檢驗規(guī)則。

詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條

件。

.4輸出數(shù)據(jù)

詳細描述子功能1所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。

.5業(yè)務(wù)算法和流程

從業(yè)務(wù)角度詳細描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流

程。

8.221.6數(shù)據(jù)設(shè)計

給出本程序中的局部數(shù)據(jù)結(jié)構(gòu)說明，包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說

明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋設(shè)計、取值）等。相關(guān)數(shù)據(jù)庫表，

數(shù)據(jù)存儲設(shè)計（具體說明需要以文件方式保存的數(shù)據(jù)文件名數(shù)據(jù)存儲

觸蝴薇屬崢

8.221.7源程序文件說明

給出本程序的各源程序文件的說明，包括源程序文件名稱及其所

14/21

軟件詳細設(shè)計文檔模板（最全面）

在目錄，功能說明，包含的前導(dǎo)文件及函數(shù)名稱等。

8.2,2.1,8函數(shù)說明

具體說明本程序中的各個函數(shù)，包括函數(shù)名稱及其所在文件，功

能，格式，參數(shù)，全局變量，局部變量，返回值，算法說明，使用約

束等。

8.2,2,1.9限制條件

8.2,2.1.10其他說明

9.接口設(shè)計

9.1內(nèi)部接口

9.2外部接口

9.2.1接口說明

例如：XX子系統(tǒng)通過XX從XX子系統(tǒng)取得XX等，相關(guān)標準，調(diào)

用示例，可根據(jù)需要增加章節(jié)描述接口。

9.2.2調(diào)用方式

例如：內(nèi)部接口調(diào)用：

例：

/**

*通過用戶服務(wù)號碼取得該客戶認證密碼等信息如，果該客戶存在

15/21

軟件詳細設(shè)計文檔模板(最全面)

返回為0,其他情況參考錯誤編碼

*/

publicRUserlnfogetUserlnfo(StringuserNo);

10.數(shù)據(jù)庫設(shè)計

詳見［xxx數(shù)據(jù)庫設(shè)計說明書］

如果數(shù)據(jù)庫設(shè)計內(nèi)容比較少，則直接在此處描述。

11.系統(tǒng)安全保密設(shè)計

11.1說明

例如：由于存在與外部系統(tǒng)的接口,所以需要考慮訪問安全的問

題.

11.2設(shè)計

例如：分為數(shù)據(jù)傳輸部分IP過濾部分,身份驗證部分.［章節(jié)可補

充］

11.2.1數(shù)據(jù)傳輸部分

例如：在部分數(shù)據(jù)傳遞的時候,考慮以https協(xié)議,需要在部署的

時候作相關(guān)處理.

11.2.2ip過濾分部

例如：可在系統(tǒng)前端通過Filter實現(xiàn)，該FiIter實現(xiàn)對該地址訪

問的IP過濾作用.可信任IP地址通過xml文件進行配置.

16/21

軟件詳細設(shè)計文檔模板(最全面)

11.2.3身份驗證部分

例如：對信任的用戶,頒發(fā)身份驗證碼,通過該標識進行身份識別

12.系統(tǒng)性能設(shè)計

13.系統(tǒng)出錯處理

例如：為了在系統(tǒng)出現(xiàn)異常情況下給用戶以明確的提示，可采用

兩種方式予以提示:

1.使用Javascript的alert()函數(shù)直接提示，這主要在輸入或

修改的情況下使用;

2.使用統(tǒng)一的錯誤界面提示該，界面對應(yīng)于errorpage,jsp頁面。

錯誤界面樣式如下圖所示:

錯誤提示：“錯誤提示內(nèi)容”

錯誤提示界面

17/21

軟件詳細設(shè)計文檔模板(最全面)

14.設(shè)計和開發(fā)規(guī)范

【可以列表方式列出設(shè)計開發(fā)的參考文檔的索引內(nèi)，容校"關(guān)鍵

內(nèi)容可以章節(jié)方式填寫】

14.1數(shù)據(jù)庫設(shè)計規(guī)范

【參見《XXXX數(shù)據(jù)庫設(shè)計規(guī)范〉】

14.2.NET編碼規(guī)范

特別強調(diào)：

令詳細請參見《ASP.Net文檔規(guī)范》

令這里只做簡單闡述，如有變動，會及時同事整個項目組相關(guān)人

員。

(1)不要給類名加前綴。使用PascalCasing風(fēng)格，不使用

匈牙利命名法。

(2)要用名詞詞組來給類型命名。使用PascalCasing風(fēng)

格。

(3)類名少用縮寫，不要使用下劃線字符(_)?

(4)基類CBase的文件名為：FileBase.cs;

(5)泛型類命名：考慮用T來命名參數(shù)類型，類如：public

classList<T>0

(6)接口(Interface)命名規(guī)范和類命名規(guī)范相同，唯一

區(qū)別是接口在名字前加上“I”前綴。

(7)枚舉命名：以復(fù)數(shù)結(jié)尾，表明這是一個枚舉，例如：Enum

18/21

軟件詳細設(shè)計文檔模板(最全面)

ColorButtons

(8)結(jié)構(gòu)命名：表明這是一個結(jié)構(gòu)體，例如：Structure

CustomerInfoRecord'以Record結(jié)尾

令除使用工具直接生成的類外，其它所有類的功能要有注釋，即

使只是一個數(shù)據(jù)對象；非常見功能的API必須要有功能描述的

注釋。獨立的要被應(yīng)用其他功能所調(diào)用的模塊的接口和公共API

的注釋要完備，即包括功能說明、參數(shù)和返回值說明。其它情

況的API的注釋盡量完備，但不強制要求。

令一次性的流打開后必須關(guān)閉和釋放。一般地，在流打開后，都

有一個trycatch語句，務(wù)必加上finally塊釋放流資源。

令即使IF,While是單語句，也要使用“{}”來劃分程序塊。

令不要有完全為調(diào)試使用的日志信息，如xxxx.info(“1”)；

如要使用，在調(diào)試完成后請及時刪除。

令一些常識性代碼，不需要寫沒必要的注釋。

令不要用工具生成沒用的注釋。

14.3代碼目錄結(jié)構(gòu)

系統(tǒng)架構(gòu)目錄結(jié)構(gòu)設(shè)計圖，如下：

19/21

軟件詳細設(shè)計文檔模板（最全面）

□解決方案'Author1/(2個項目)

義腳本文檔

E)Axithority

S)@Properties

fflT引用

_App_D@ta

B'二Content

田廠」［mages

日Seripis

-「二iquei?廠easyuLL2.6

l￡C3locale

tLJIplugins

IS口themes

easyloader.js

二］jquery_1.7.2.min.Js

］jquery,easjnii.min.js

3j^uery^ui-l.8.20

由jthok-ui

ffi亡3themes

ffi」Contf

S)Data

4?jModels

E)__jScripts

S)i_iYiews

由Global.asax

ffi-臥ffeb.config

結(jié)構(gòu)說明：

作用范圍包名描述

Images存放圖片

Scripts