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

2、5. 數據庫設計86. 系統安全保密設計86.1 說明86.2 設計86.2.1 數據傳輸部分86.2.2 IP過濾分部86.2.3 身份驗證部分87. 系統性能設計98. 系統出錯處理91. 引言1.1 背景此文檔的背景1.2 編寫目的和范圍說明寫這份詳細設計說明書的目的。本詳細設計說明書編寫的目的是說明程序模塊的設計考慮，包括程序描述、輸入/輸出、算法和流程邏輯等，為軟件編程和系統維護提供基礎。本說明書的預期讀者為系統設計人員、軟件開發人員、軟件測試人員和項目評審人員。1.3 術語表定義系統或產品中涉及的重要術語，為讀者在閱讀文檔時提供必要的參考信息。序號術語或縮略語說明性定義1PMPro

3、ject Manager,項目經理21.4 參考資料列出有關資料的名稱、作者、文件編號或版本等。參考資料包括：a需求說明書、架構設計說明書等；b本項目的其他已發表的文件；c引用文件、資料、軟件開發標準等。資料名稱作者文件編號、版本資料存放地點1.5 使用的文字處理和繪圖工具文字處理軟件：編寫設計文檔使用的文字處理軟件，如RedOffice 繪圖工具：使用的UML工具，如Rose、Jude、Visio2. 設計概述2.1 任務和目標2.1.1 需求概述2.1.2 運行環境概述2.1.3 條件與限制2.1.4 詳細設計方法和工具3. 系統詳細需求分析主要對系統級的需求進行分析。首先應對需求分析提出

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

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

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

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

8、的部分說明。6.4.1 外部界面設計根據系統界面劃分進行系統外部界面設計，對系統的所有外部接口（包括功能和數據接口）進行設計。6.4.2 內部界面設計設計系統內部各功能模塊間的調用關系和數據接口。6.4.3 用戶界面設計規定人機界面的內容、界面風格、調用方式等，包括所謂的表單設計、報表設計和用戶需要的打印輸出等設計。此部分內容可能比較多。7. 開發和測試生產環境說明7.1 開發環境7.2 測試及產品環境- Development evnironment: programming lanuague, databaseVs 2010 - svn - iss 6.1 + - mysql/sql se

9、rver 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的業務功能。.3 輸入數據詳細描述用戶輸入的數據(包括任何輸入設備)以及這些數據的有效性檢驗規

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

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

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

13、全局變量，局部變量，返回值，算法說明，使用約束等。.9 限制條件.10 其他說明9. 接口設計9.1 內部接口9.2 外部接口9.2.1 接口說明例如：*子系統通過*從*子系統取得*等，相關標準，調用示例，可根據需要增加章節描述接口。9.2.2 調用方式例如：內部接口調用：例: /*通過用戶服務號碼取得該客戶認證密碼等信息，如果該客戶存在返回為0，其他情況參考錯誤編碼*/public RUserInfo getUserInfo (String userNo);10. 數據庫設計詳見*x數據庫設計說明書如果數據庫設計內容比較少，則直接在此處描述。11. 系統安全保密設

14、計11.1 說明例如：由于存在與外部系統的接口,所以需要考慮訪問安全的問題.11.2 設計例如：分為數據傳輸部分,IP過濾部分,身份驗證部分.章節可補充11.2.1 數據傳輸部分例如：在部分數據傳遞的時候,考慮以https協議,需要在部署的時候作相關處理.11.2.2 IP過濾分部例如：可在系統前端通過Filter實現,該Filter實現對該地址訪問的IP過濾作用.可信任IP地址通過xml文件進行配置.11.2.3 身份驗證部分例如：對信任的用戶,頒發身份驗證碼,通過該標識進行身份識別.12. 系統性能設計13. 系統出錯處理例如：為了在系統出現異常情況下給用戶以明確的提示，可采用兩種方式予以

15、提示：1使用Javascript的alert()函數直接提示，這主要在輸入或修改的情況下使用；2使用統一的錯誤界面提示，該界面對應于errorpage.jsp頁面。錯誤界面樣式如下圖所示：錯誤提示界面14. 設計和開發規范【可以列表方式列出設計開發的參考文檔的索引，內容較少/關鍵內容可以章節方式填寫】14.1 數據庫設計規范【參見*數據庫設計規范】14.2 .NET編碼規范特別強調：² 詳細請參見ASP.Net文檔規范² 這里只做簡單闡述，如有變動，會及時同事整個項目組相關人員。(1)不要給類名加前綴。使用PascalCasing風格，不使用匈牙利命名法 。 (2)要用名詞

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

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