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

1、研發(fā)生產(chǎn)中心文檔編號(hào)版本A1密級(jí)商密A項(xiàng)目名稱Xx系統(tǒng)項(xiàng)目來(lái)源Xxx系統(tǒng)詳細(xì)設(shè)計(jì)說(shuō)明書 (內(nèi)部資料 請(qǐng)勿外傳)編 寫：日 期：檢 查：日 期：審 核：日 期：批 準(zhǔn)：日 期：XX公司版權(quán)所有 不得復(fù)制文檔變更記錄序號(hào)變更（+/-）說(shuō)明作者版本號(hào)日期批準(zhǔn)12目 錄1. 引言41.1 編寫目的和范圍41.2 術(shù)語(yǔ)表41.3 參考資料41.4 使用的文字處理和繪圖工具42. 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說(shuō)明52.1 常量52.2 變量52.3 數(shù)據(jù)結(jié)構(gòu)53. 模塊設(shè)計(jì)53.1 用例圖53.2 功能設(shè)計(jì)說(shuō)明53.2.1 模塊153.2.2 模塊264. 接口設(shè)計(jì)74.1 內(nèi)部接口74.2 外部接口74.2.1 接口說(shuō)

2、明74.2.2 調(diào)用方式85. 數(shù)據(jù)庫(kù)設(shè)計(jì)86. 系統(tǒng)安全保密設(shè)計(jì)86.1 說(shuō)明86.2 設(shè)計(jì)86.2.1 數(shù)據(jù)傳輸部分86.2.2 IP過(guò)濾分部86.2.3 身份驗(yàn)證部分87. 系統(tǒng)性能設(shè)計(jì)98. 系統(tǒng)出錯(cuò)處理91. 引言1.1 背景此文檔的背景1.2 編寫目的和范圍說(shuō)明寫這份詳細(xì)設(shè)計(jì)說(shuō)明書的目的。本詳細(xì)設(shè)計(jì)說(shuō)明書編寫的目的是說(shuō)明程序模塊的設(shè)計(jì)考慮，包括程序描述、輸入/輸出、算法和流程邏輯等，為軟件編程和系統(tǒng)維護(hù)提供基礎(chǔ)。本說(shuō)明書的預(yù)期讀者為系統(tǒng)設(shè)計(jì)人員、軟件開發(fā)人員、軟件測(cè)試人員和項(xiàng)目評(píng)審人員。1.3 術(shù)語(yǔ)表定義系統(tǒng)或產(chǎn)品中涉及的重要術(shù)語(yǔ)，為讀者在閱讀文檔時(shí)提供必要的參考信息。序號(hào)術(shù)語(yǔ)或縮

3、略語(yǔ)說(shuō)明性定義1PMProject Manager,項(xiàng)目經(jīng)理21.4 參考資料列出有關(guān)資料的名稱、作者、文件編號(hào)或版本等。參考資料包括：a需求說(shuō)明書、架構(gòu)設(shè)計(jì)說(shuō)明書等；b本項(xiàng)目的其他已發(fā)表的文件；c引用文件、資料、軟件開發(fā)標(biāo)準(zhǔn)等。 資料名稱作者文件編號(hào)、版本資料存放地點(diǎn)1.5 使用的文字處理和繪圖工具文字處理軟件：編寫設(shè)計(jì)文檔使用的文字處理軟件，如RedOffice 繪圖工具：使用的UML工具，如Rose、Jude、Visio2. 設(shè)計(jì)概述2.1 任務(wù)和目標(biāo)2.1.1 需求概述2.1.2 運(yùn)行環(huán)境概述2.1.3 條件與限制2.1.4 詳細(xì)設(shè)計(jì)方法和工具3. 系統(tǒng)詳細(xì)需求分析主要對(duì)系統(tǒng)級(jí)的需求進(jìn)

4、行分析。首先應(yīng)對(duì)需求分析提出的企業(yè)需求進(jìn)一步確認(rèn)，并對(duì)由于情況變化而帶來(lái)的需求變化進(jìn)行較為詳細(xì)的分析。3.1 詳細(xì)需求分析3.1.1 詳細(xì)功能需求分析3.1.2 詳細(xì)性能需求分析3.1.3 詳細(xì)資源需求分析3.1.4 詳細(xì)接口需求分析3.1.5 詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析4. 總體方案確認(rèn)著重解決系統(tǒng)總體結(jié)構(gòu)確認(rèn)及界面劃分問(wèn)題。4.1 系統(tǒng)總體結(jié)構(gòu)確認(rèn)對(duì)系統(tǒng)組成、邏輯結(jié)構(gòu)及層次進(jìn)行確認(rèn)，對(duì)應(yīng)用系統(tǒng)、支撐系統(tǒng)及各自實(shí)現(xiàn)的功能進(jìn)行確認(rèn)，細(xì)化集成設(shè)計(jì)及系統(tǒng)工作流程，特別要注意因軟件的引進(jìn)造成的系統(tǒng)本身結(jié)構(gòu)和公司其他系統(tǒng)的結(jié)構(gòu)變化。包括：4.1.1 系統(tǒng)組成、邏輯結(jié)構(gòu)及層次確認(rèn)4.1.2 應(yīng)用系統(tǒng)

5、結(jié)構(gòu)確認(rèn)4.1.3 支撐系統(tǒng)結(jié)構(gòu)確認(rèn)4.1.4 系統(tǒng)集成確認(rèn)4.1.5 系統(tǒng)工作流程確認(rèn)4.2 系統(tǒng)詳細(xì)界面劃分4.2.1 應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細(xì)界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)之間的界面包括系統(tǒng)主服務(wù)器與其他服務(wù)器的服務(wù)范圍及訪問(wèn)方式，網(wǎng)絡(luò)及數(shù)據(jù)庫(kù)對(duì)應(yīng)用系統(tǒng)的支撐方式，全局?jǐn)?shù)據(jù)的管理與存取方式等。4.2.2 系統(tǒng)內(nèi)部詳細(xì)界面劃分系統(tǒng)各功能之間的界面包括覆蓋范圍，模塊間功能調(diào)用涉及到的系統(tǒng)模塊及方法，全局?jǐn)?shù)據(jù)格式，系統(tǒng)性能要求等。5. 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說(shuō)明本章說(shuō)明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。5.1 常量包括數(shù)據(jù)文件名稱及其所在目錄，功能說(shuō)明，具體常量說(shuō)明等。5.2 變量本章說(shuō)明本程

6、序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。5.3 數(shù)據(jù)結(jié)構(gòu)包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說(shuō)明，具體數(shù)據(jù)結(jié)構(gòu)說(shuō)明（定義、注釋、取值）等。6. 系統(tǒng)詳細(xì)設(shè)計(jì)6.1 功能結(jié)構(gòu)圖6.2 系統(tǒng)結(jié)構(gòu)設(shè)計(jì)及子系統(tǒng)劃分對(duì)系統(tǒng)的組成及邏輯結(jié)構(gòu)進(jìn)行設(shè)計(jì)前確認(rèn)。劃分系統(tǒng)功能模塊或子系統(tǒng)（如果有或者有必要，特別是大型的軟件系統(tǒng)）。6.3 系統(tǒng)功能模塊詳細(xì)設(shè)計(jì)按結(jié)構(gòu)化設(shè)計(jì)方法，在系統(tǒng)功能逐層分解的基礎(chǔ)上，對(duì)系統(tǒng)各功能模塊或子系統(tǒng)進(jìn)行設(shè)計(jì)。此為詳細(xì)設(shè)計(jì)的主要部分之一。用層次圖描述系統(tǒng)的總體結(jié)構(gòu)、功能分解及各個(gè)模塊之間的相互調(diào)用關(guān)系和信息交互，用IPO圖或其他方法描述各模塊完成的功能。 以上建議采用HIPO圖進(jìn)行功能分解與模塊描

7、述，更高的要求建議采用IDEF0方法進(jìn)行功能模型設(shè)計(jì)。詳細(xì)設(shè)計(jì)應(yīng)用系統(tǒng)的各個(gè)構(gòu)成模塊完成的功能及其相互之間的關(guān)系，用IPO或結(jié)構(gòu)圖描述各模塊的組成結(jié)構(gòu)、算法、模塊間的接口關(guān)系，以及需求、功能和模塊三者之間的交叉參照關(guān)系。每個(gè)模塊的描述說(shuō)明可參照以下格式：模塊編號(hào)：模塊名稱：輸入：處理：算法描述：輸出：其中處理和算法描述部分主要采用偽碼或具體的程序語(yǔ)言完成。對(duì)詳細(xì)設(shè)計(jì)更高的要求建議用IDEF0圖進(jìn)行各功能模塊的設(shè)計(jì)。如果對(duì)軟件需進(jìn)行二次開發(fā)（包括功能擴(kuò)展、功能改造、用戶界面改造等），則相應(yīng)的設(shè)計(jì)工作應(yīng)該設(shè)立子課題完成。6.4 系統(tǒng)界面詳細(xì)設(shè)計(jì)系統(tǒng)界面說(shuō)明應(yīng)用系統(tǒng)軟件的各種接口。整個(gè)系統(tǒng)的其他接口

8、（如系統(tǒng)硬件接口、通訊接口等）在相應(yīng)的部分說(shuō)明。6.4.1 外部界面設(shè)計(jì)根據(jù)系統(tǒng)界面劃分進(jìn)行系統(tǒng)外部界面設(shè)計(jì)，對(duì)系統(tǒng)的所有外部接口（包括功能和數(shù)據(jù)接口）進(jìn)行設(shè)計(jì)。6.4.2 內(nèi)部界面設(shè)計(jì)設(shè)計(jì)系統(tǒng)內(nèi)部各功能模塊間的調(diào)用關(guān)系和數(shù)據(jù)接口。6.4.3 用戶界面設(shè)計(jì)規(guī)定人機(jī)界面的內(nèi)容、界面風(fēng)格、調(diào)用方式等，包括所謂的表單設(shè)計(jì)、報(bào)表設(shè)計(jì)和用戶需要的打印輸出等設(shè)計(jì)。此部分內(nèi)容可能比較多。7. 開發(fā)和測(cè)試生產(chǎn)環(huán)境說(shuō)明7.1 開發(fā)環(huán)境7.2 測(cè)試及產(chǎn)品環(huán)境- Development evnironment: programming lanuague, databaseVs 2010 - svn - iss 6.

9、1 + - mysql/sql server 2005/2008 - .net framwork 4.0- Testing & production environment: OS, database - .net framwork 4.0Windwos 2003, iis 6.0, MySQL, 8. 模塊設(shè)計(jì)8.1 用例圖8.2 功能設(shè)計(jì)說(shuō)明8.2.1 模塊1模塊1主要分為以下幾個(gè)子模塊：子模塊1、子模塊2和子模塊N。 子模塊.1 設(shè)計(jì)圖.2 功能描述簡(jiǎn)要描述子模塊1的業(yè)務(wù)功能。.3 輸入數(shù)據(jù)詳細(xì)描述用戶輸入的數(shù)據(jù)(包括任何

10、輸入設(shè)備)以及這些數(shù)據(jù)的有效性檢驗(yàn)規(guī)則。詳細(xì)描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。.4 輸出數(shù)據(jù)詳細(xì)描述子功能1所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。.5 業(yè)務(wù)算法和流程從業(yè)務(wù)角度詳細(xì)描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流程。.6 數(shù)據(jù)設(shè)計(jì)給出本程序中的局部數(shù)據(jù)結(jié)構(gòu)說(shuō)明，包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說(shuō)明，具體數(shù)據(jù)結(jié)構(gòu)說(shuō)明（定義、注釋設(shè)計(jì)、取值）等。相關(guān)數(shù)據(jù)庫(kù)表，數(shù)據(jù)存儲(chǔ)設(shè)計(jì)（具體說(shuō)明需要以文件方式保存的數(shù)據(jù)文件名、數(shù)據(jù)存儲(chǔ)格式、數(shù)據(jù)項(xiàng)及屬性等。）.7 源程序文件說(shuō)明給出本程序的各源程序文件的說(shuō)明，包括源程序文件名稱及其所在目

11、錄，功能說(shuō)明，包含的前導(dǎo)文件及函數(shù)名稱等。.8 函數(shù)說(shuō)明具體說(shuō)明本程序中的各個(gè)函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局變量，局部變量，返回值，算法說(shuō)明，使用約束等。.9 限制條件.10 其他說(shuō)明8.2.2 模塊2模塊1主要分為以下幾個(gè)子模塊：子模塊1、子模塊2和子模塊N。 子模塊.1 設(shè)計(jì)圖.2 功能描述簡(jiǎn)要描述子模塊1的業(yè)務(wù)功能。.3 輸入數(shù)據(jù)詳細(xì)描述用戶輸入的數(shù)據(jù)(包括任何輸入設(shè)備)以及這些數(shù)據(jù)的有效性檢驗(yàn)規(guī)則。詳細(xì)描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。8.2

12、.2.1.4 輸出數(shù)據(jù)詳細(xì)描述子功能1所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。.5 業(yè)務(wù)算法和流程從業(yè)務(wù)角度詳細(xì)描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流程。.6 數(shù)據(jù)設(shè)計(jì)給出本程序中的局部數(shù)據(jù)結(jié)構(gòu)說(shuō)明，包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說(shuō)明，具體數(shù)據(jù)結(jié)構(gòu)說(shuō)明（定義、注釋設(shè)計(jì)、取值）等。相關(guān)數(shù)據(jù)庫(kù)表，數(shù)據(jù)存儲(chǔ)設(shè)計(jì)（具體說(shuō)明需要以文件方式保存的數(shù)據(jù)文件名、數(shù)據(jù)存儲(chǔ)格式、數(shù)據(jù)項(xiàng)及屬性等。）.7 源程序文件說(shuō)明給出本程序的各源程序文件的說(shuō)明，包括源程序文件名稱及其所在目錄，功能說(shuō)明，包含的前導(dǎo)文件及函數(shù)名稱等。.8 函數(shù)說(shuō)明具體說(shuō)明本程序中的各個(gè)函數(shù)，包括函數(shù)

13、名稱及其所在文件，功能，格式，參數(shù)，全局變量，局部變量，返回值，算法說(shuō)明，使用約束等。.9 限制條件.10 其他說(shuō)明9. 接口設(shè)計(jì)9.1 內(nèi)部接口9.2 外部接口9.2.1 接口說(shuō)明例如：xx子系統(tǒng)通過(guò)xx從xx子系統(tǒng)取得xx等，相關(guān)標(biāo)準(zhǔn)，調(diào)用示例，可根據(jù)需要增加章節(jié)描述接口。9.2.2 調(diào)用方式例如：內(nèi)部接口調(diào)用：例: /*通過(guò)用戶服務(wù)號(hào)碼取得該客戶認(rèn)證密碼等信息，如果該客戶存在返回為0，其他情況參考錯(cuò)誤編碼*/public RUserInfo getUserInfo (String userNo);10. 數(shù)據(jù)庫(kù)設(shè)計(jì)詳見xxx數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書如果數(shù)據(jù)庫(kù)設(shè)計(jì)內(nèi)容比

14、較少，則直接在此處描述。11. 系統(tǒng)安全保密設(shè)計(jì)11.1 說(shuō)明例如：由于存在與外部系統(tǒng)的接口,所以需要考慮訪問(wèn)安全的問(wèn)題.11.2 設(shè)計(jì)例如：分為數(shù)據(jù)傳輸部分,IP過(guò)濾部分,身份驗(yàn)證部分.章節(jié)可補(bǔ)充11.2.1 數(shù)據(jù)傳輸部分例如：在部分?jǐn)?shù)據(jù)傳遞的時(shí)候,考慮以https協(xié)議,需要在部署的時(shí)候作相關(guān)處理.11.2.2 IP過(guò)濾分部例如：可在系統(tǒng)前端通過(guò)Filter實(shí)現(xiàn),該Filter實(shí)現(xiàn)對(duì)該地址訪問(wèn)的IP過(guò)濾作用.可信任IP地址通過(guò)xml文件進(jìn)行配置.11.2.3 身份驗(yàn)證部分例如：對(duì)信任的用戶,頒發(fā)身份驗(yàn)證碼,通過(guò)該標(biāo)識(shí)進(jìn)行身份識(shí)別.12. 系統(tǒng)性能設(shè)計(jì)13. 系統(tǒng)出錯(cuò)處理例如：為了在系統(tǒng)出現(xiàn)異

15、常情況下給用戶以明確的提示，可采用兩種方式予以提示：1使用Javascript的alert()函數(shù)直接提示，這主要在輸入或修改的情況下使用；2使用統(tǒng)一的錯(cuò)誤界面提示，該界面對(duì)應(yīng)于errorpage.jsp頁(yè)面。錯(cuò)誤界面樣式如下圖所示：錯(cuò)誤提示界面14. 設(shè)計(jì)和開發(fā)規(guī)范【可以列表方式列出設(shè)計(jì)開發(fā)的參考文檔的索引，內(nèi)容較少/關(guān)鍵內(nèi)容可以章節(jié)方式填寫】14.1 數(shù)據(jù)庫(kù)設(shè)計(jì)規(guī)范【參見XXXX數(shù)據(jù)庫(kù)設(shè)計(jì)規(guī)范】14.2 .NET編碼規(guī)范特別強(qiáng)調(diào)：² 詳細(xì)請(qǐng)參見ASP.Net文檔規(guī)范² 這里只做簡(jiǎn)單闡述，如有變動(dòng)，會(huì)及時(shí)同事整個(gè)項(xiàng)目組相關(guān)人員。(1)不要給類名加前綴。使用PascalCa

16、sing風(fēng)格，不使用匈牙利命名法 。 (2)要用名詞詞組來(lái)給類型命名。使用PascalCasing風(fēng)格 。 (3)類名少用縮寫,不要使用下劃線字符 (_)。 (4)基類CBase的文件名為：FileBase.cs;(5) 泛型類命名：考慮用T來(lái)命名參數(shù)類型 ，類如：public class List<T>。(6)接口（Interface）命名規(guī)范和類命名規(guī)范相同，唯一區(qū)別是 接口在名字前加上“I”前綴。(7)枚舉命名：以復(fù)數(shù)結(jié)尾，表明這是一個(gè)枚舉，例如：Enum ColorButtons (8)結(jié)構(gòu)命名：表明這是一個(gè)結(jié)構(gòu)體，例如：Structure CustomerInfoReco

17、rd '以Record結(jié)尾² 除使用工具直接生成的類外，其它所有類的功能要有注釋，即使只是一個(gè)數(shù)據(jù)對(duì)象；非常見功能的API必須要有功能描述的注釋。獨(dú)立的要被應(yīng)用其他功能所調(diào)用的模塊的接口和公共API的注釋要完備，即包括功能說(shuō)明、參數(shù)和返回值說(shuō)明。其它情況的API的注釋盡量完備，但不強(qiáng)制要求。² 一次性的流打開后必須關(guān)閉和釋放。一般地，在流打開后，都有一個(gè)try catch語(yǔ)句，務(wù)必加上finally塊釋放流資源。² 即使IF，While是單語(yǔ)句，也要使用“ ”來(lái)劃分程序塊。² 不要有完全為調(diào)試使用的日志信息，如(“1”)；如要使用，在調(diào)試完成后請(qǐng)及時(shí)刪除。² 一些常識(shí)性代碼，不需要寫沒必要的注釋。² 不要用工具生成沒用的注釋。14.3 代碼目錄結(jié)構(gòu)系統(tǒng)架構(gòu)目錄結(jié)構(gòu)設(shè)計(jì)圖,如下：結(jié)構(gòu)說(shuō)明：作用范圍包名描述整個(gè)程序ContentImages存放圖片ScriptsJquery以及樣式表等Scripts/jquery-easyui-1.2.6jquery-easyui包數(shù)字為版本Scripts/j