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

1、實用標準文檔文案大全研發(fā)生產(chǎn)中心文檔編號版本A1密級商密 A項目名稱Xx 系統(tǒng)項目來源Xxx 系統(tǒng)詳細設(shè)計說明書（ 內(nèi)部資料 請勿外傳 ）期：期：期：期：編檢審批XX公司版權(quán)所有 不得復(fù)制文檔變更記錄序號變更（ +/- ）說明作者版本號日期批準12目錄 TOC o 1-5 h z HYPERLINK l bookmark4 o Current Document 引言 5 HYPERLINK l bookmark8 o Current Document 編寫目的和范圍 . 5 HYPERLINK l bookmark10 o Current Document 術(shù)語表 . 5 HYPERLINK

2、l bookmark12 o Current Document 參考資料 . 5 HYPERLINK l bookmark14 o Current Document 使用的文字處理和繪圖工具 . 5 HYPERLINK l bookmark32 o Current Document 全局數(shù)據(jù)結(jié)構(gòu)說明. 7 HYPERLINK l bookmark34 o Current Document 常量. 7 HYPERLINK l bookmark36 o Current Document 變量. 8 HYPERLINK l bookmark38 o Current Document 數(shù)據(jù)結(jié)構(gòu) . 8

3、 HYPERLINK l bookmark56 o Current Document 模塊設(shè)計 . 9用例圖 . 9 HYPERLINK l bookmark58 o Current Document 功能設(shè)計說明 . 10 HYPERLINK l bookmark60 o Current Document 模塊 1 10 HYPERLINK l bookmark76 o Current Document 模塊 2 11 HYPERLINK l bookmark100 o Current Document 接口設(shè)計 . 12 HYPERLINK l bookmark102 o Current

4、Document 內(nèi)部接口 . 12 HYPERLINK l bookmark104 o Current Document 外部接口 . 12 HYPERLINK l bookmark106 o Current Document 接口說明 . 12 HYPERLINK l bookmark108 o Current Document 調(diào)用方式 . 12數(shù)據(jù)庫設(shè)計 . 12 HYPERLINK l bookmark112 o Current Document 系統(tǒng)安全保密設(shè)計. 12說明. 12設(shè)計. 12 HYPERLINK l bookmark118 o Current Document 數(shù)

5、據(jù)傳輸部分 . 12IP 過濾分部 13身份驗證部分 . 13 HYPERLINK l bookmark120 o Current Document 系統(tǒng)性能設(shè)計 . 13 HYPERLINK l bookmark122 o Current Document 系統(tǒng)出錯處理 . 13引言背景此文檔的背景編寫目的和范圍說明寫這份詳細設(shè)計說明書的目的。本詳細設(shè)計說明書編寫的目的是說明程序模塊的設(shè)計考慮， 包括程序描述、輸入/ 輸出、 算法和流程邏輯等，為軟件編程和系統(tǒng)維護提供基礎(chǔ)。 本說明書的預(yù)期讀者為系統(tǒng)設(shè)計人員、 軟件開發(fā)人員、軟件測試人員和項目評審人員。術(shù)語表定義系統(tǒng)或產(chǎn)品中涉及的重要術(shù)語，為

6、讀者在閱讀文檔時提供必要的參考信息序號術(shù)語或縮略語說明性定義1PMProject Manager, 項目經(jīng)理2參考資料列出有關(guān)資料的名稱、作者、文件編號或版本等。參考資料包括： a需求說明書、架構(gòu)設(shè)計說明書等； b本項目的其他已發(fā)表的文件； c引用文件、資料、軟件開發(fā)標準等。資料名稱作者文件編號、版本資料存放地點使用的文字處理和繪圖工具文字處理軟件： 編寫設(shè)計文檔使用的文字處理軟件，如 RedOffice 繪圖工具： 使用的 UML工具，如 Rose、Jude、Visio設(shè)計概述任務(wù)和目標2.1.1 需求概述運行環(huán)境概述條件與限制2.1.4 詳細設(shè)計方法和工具系統(tǒng)詳細需求分析并對由主要對系統(tǒng)級

7、的需求進行分析。 首先應(yīng)對需求分析提出的企業(yè)需求進一步確認， 于情況變化而帶來的需求變化進行較為詳細的分析。詳細需求分析3.1.1 詳細功能需求分析3.1.2 詳細性能需求分析3.1.3 詳細資源需求分析3.1.4 詳細接口需求分析詳細系統(tǒng)運行環(huán)境及限制條件分析總體方案確認著重解決系統(tǒng)總體結(jié)構(gòu)確認及界面劃分問題。系統(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)變化。包括：系統(tǒng)組成、邏輯結(jié)構(gòu)及層次確認4.1.2 應(yīng)用系統(tǒng)結(jié)構(gòu)確認4.1.3 支撐系統(tǒng)結(jié)

8、構(gòu)確認系統(tǒng)集成確認4.1.5 系統(tǒng)工作流程確認系統(tǒng)詳細界面劃分應(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)性能要求等。全局數(shù)據(jù)結(jié)構(gòu)說明本章說明本程序系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。常量包括數(shù)據(jù)文件名稱及其所在目錄，功能說明，具體常量說明等。變量本章說明本程序系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。數(shù)據(jù)結(jié)構(gòu)包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說

9、明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋、取值）等。系統(tǒng)詳細設(shè)計功能結(jié)構(gòu)圖系統(tǒng)結(jié)構(gòu)設(shè)計及子系統(tǒng)劃分對系統(tǒng)的組成及邏輯結(jié)構(gòu)進行設(shè)計前確認。 劃分系統(tǒng)功能模塊或子系統(tǒng)（如果有或者有必要，特別是大型的軟件系統(tǒng)） 。系統(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圖進行功能分解與模塊描 述，更高的要求建議采用 IDEF0方法進行功能模型設(shè)計。詳細設(shè)計應(yīng)用系統(tǒng)的各個構(gòu)成模塊完成的功

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

11、行系統(tǒng)外部界面設(shè)計， 對系統(tǒng)的所有外部接口 （包括功能和數(shù)據(jù)接 口）進行設(shè)計。內(nèi)部界面設(shè)計設(shè)計系統(tǒng)內(nèi)部各功能模塊間的調(diào)用關(guān)系和數(shù)據(jù)接口。用戶界面設(shè)計 規(guī)定人機界面的內(nèi)容、界面風(fēng)格、調(diào)用方式等，包括所謂的表單設(shè)計、報表設(shè)計和用戶 需要的打印輸出等設(shè)計。此部分內(nèi)容可能比較多。開發(fā)和測試生產(chǎn)環(huán)境說明開發(fā)環(huán)境測試及產(chǎn)品環(huán)境- Development evnironment: programming lanuague, databaseVs 2010 - svn - iss 6.1 + - mysql/sql server 2005/2008 - .net framwork 4.0- Testing &

12、 production environment: OS, database - .net framwork 4.0Windwos 2003, iis 6.0, MySQL,模塊設(shè)計用例圖功能設(shè)計說明8.2.1 模塊 1模塊 1主要分為以下幾個子模塊：子模塊 1、子模塊 2 和子模塊 N。子模塊 1設(shè)計圖功能描述 簡要描述子模塊 1 的業(yè)務(wù)功能。輸入數(shù)據(jù) 詳細描述用戶輸入的數(shù)據(jù) （ 包括任何輸入設(shè)備 ） 以及這些數(shù)據(jù)的有效性檢驗規(guī)則。 詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。輸出數(shù)據(jù)詳細描述子功能 1 所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。業(yè)務(wù)算法和流程 從業(yè)務(wù)角度詳細描述根據(jù)

13、輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流程。數(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ù)存儲格式、數(shù)據(jù)項及屬性等。 ）源程序文件說明給出本程序的各源程序文件的說明， 包括源程序文件名稱及其所在目錄， 功能說明， 包 含的前導(dǎo)文件及函數(shù)名稱等。函數(shù)說明 具體說明本程序中的各個函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局 變量，局部變量，返回值，算法說明，使用約束等。限制條件其他說明8.2.2 模塊 2模塊 1主要分為以下幾個子模塊：子模塊 1、子

14、模塊 2 和子模塊 N。子模塊 1設(shè)計圖功能描述簡要描述子模塊 1 的業(yè)務(wù)功能。輸入數(shù)據(jù)詳細描述用戶輸入的數(shù)據(jù) （ 包括任何輸入設(shè)備 ） 以及這些數(shù)據(jù)的有效性檢驗規(guī)則。詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。輸出數(shù)據(jù)詳細描述子功能 1 所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。業(yè)務(wù)算法和流程從業(yè)務(wù)角度詳細描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流程。數(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ù)存儲格式、數(shù)據(jù)項及屬性等。 ）源程序文件說

15、明給出本程序的各源程序文件的說明， 包括源程序文件名稱及其所在目錄， 功能說明， 包 含的前導(dǎo)文件及函數(shù)名稱等。函數(shù)說明具體說明本程序中的各個函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局 變量，局部變量，返回值，算法說明，使用約束等。限制條件其他說明接口設(shè)計內(nèi)部接口外部接口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ù)號碼取得該客戶認證密碼等信息，如果該客戶存在返回為0，其他情況參考錯誤編碼*/public RUserInfo getUser

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

17、驗證碼 ,通過該標識進行身份識別 .系統(tǒng)性能設(shè)計系統(tǒng)出錯處理例如：為了在系統(tǒng)出現(xiàn)異常情況下給用戶以明確的提示，可采用兩種方式予以提示： 1使用 Javascript 的 alert() 函數(shù)直接提示，這主要在輸入或修改的情況下使用； 2使用統(tǒng)一的錯誤界面提示，該界面對應(yīng)于 errorpage.jsp 頁面。錯誤界面樣式如下 圖所示：錯誤提示 : “錯誤提示內(nèi)容”返回錯誤提示界面設(shè)計和開發(fā)規(guī)范【可以列表方式列出設(shè)計開發(fā)的參考文檔的索引，內(nèi)容較少 / 關(guān)鍵內(nèi)容可以章節(jié)方式填 寫】數(shù)據(jù)庫設(shè)計規(guī)范【 參見 XXXX數(shù)據(jù)庫設(shè)計規(guī)范】.NET 編碼規(guī)范特別強調(diào)：詳細請參見 ASP.Net 文檔規(guī)范 這里只

18、做簡單闡述，如有變動，會及時同事整個項目組相關(guān)人員。不要給類名加前綴。使用 PascalCasing 風(fēng)格，不使用匈牙利命名法 。要用名詞詞組來給類型命名。使用 PascalCasing 風(fēng)格 。類名少用縮寫 , 不要使用下劃線字符 (_) 。基類 CBase 的文件名為： FileBase.cs;泛型類命名：考慮用 T 來命名參數(shù)類型 ，類如： public class List 。接口( Interface )命名規(guī)范和類命名規(guī)范相同， 唯一區(qū)別是 接口在名字前加 上“ I”前綴。枚舉命名：以復(fù)數(shù)結(jié)尾，表明這是一個枚舉，例如： Enum ColorButtons結(jié)構(gòu)命名：表明這是一個結(jié)構(gòu)體，例如：Structure CustomerInfoRecord 以 Record 結(jié)尾除使用工具直接生成的類外， 其它所有類的功能要有注釋， 即使只是一個數(shù)據(jù)對象； 非常見功能的 API 必須要有功能描述的注釋。 獨立的要被應(yīng)用其他功能所調(diào)用的模 塊的接口和公共 API 的注釋要完備， 即包括功能說明、 參數(shù)和返回值說明。 其它