最全軟件詳細設計文檔模板(多方位參考)

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

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

3、檔時提供必要的參考信息。序號術語或縮略語說明性定義1PMProject Manager,項目經(jīng)理21.4 參考資料列出有關資料的名稱、作者、文件編號或版本等。參考資料包括：a需求說明書、架構設計說明書等；b本項目的其他已發(fā)表的文件；c引用文件、資料、軟件開發(fā)標準等。 資料名稱作者文件編號、版本資料存放地點1.5 使用的文字處理和繪圖工具文字處理軟件：編寫設計文檔使用的文字處理軟件，如RedOffice 繪圖工具：使用的UML工具，如Rose、Jude、Visio2. 設計概述2.1 任務和目標2.1.1 需求概述2.1.2 運行環(huán)境概述2.1.3 條件與限制2.1.4 詳細設計方法和工具3.

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

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

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

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

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

9、010 - svn - iss 6.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. 模塊設計8.1 用例圖8.2 功能設計說明8.2.1 模塊1模塊1主要分為以下幾個子模塊：子模塊1、子模塊2和子模塊N。 子模塊.1 設計圖.2 功能描述簡要描述子模塊1的業(yè)務功能。.3 輸入

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

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

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

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

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

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

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

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