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

1、-. z.研發(fā)生產(chǎn)中心文檔編號(hào)版本A1商密A項(xiàng)目名稱*系統(tǒng)項(xiàng)目來源*系統(tǒng)詳細(xì)設(shè)計(jì)說明書(部資料 請勿外傳)編寫：日期：檢查：日期：審核：日期：批準(zhǔn)：日期：*公司所有不得復(fù)制文檔變更記錄序號(hào)變更（+/-）說明作者版本號(hào)日期批準(zhǔn)12目錄 TOC o 2-3 f h z t 標(biāo)題 1,1 HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115737#_Toc2661157371. 引言 PAGEREF _Toc266115737 h 4HYPERLINK file:/C:Documents%20

2、and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115738#_Toc2661157381.1 編寫目的和圍 PAGEREF _Toc266115738 h 4HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115739#_Toc2661157391.2 術(shù)語表 PAGEREF _Toc266115739 h 4HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc

3、 l _Toc266115740#_Toc2661157401.3 參考資料 PAGEREF _Toc266115740 h 4HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115741#_Toc2661157411.4 使用的文字處理和繪圖工具 PAGEREF _Toc266115741 h 4HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115742#_Toc266115742

4、2. 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說明 PAGEREF _Toc266115742 h 5HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115743#_Toc2661157432.1 常量 PAGEREF _Toc266115743 h 5HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115744#_Toc2661157442.2 變量 PAGEREF _Toc266115744 h 5HYPER

5、LINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115745#_Toc2661157452.3 數(shù)據(jù)結(jié)構(gòu) PAGEREF _Toc266115745 h 5HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115746#_Toc2661157463. 模塊設(shè)計(jì) PAGEREF _Toc266115746 h 5HYPERLINK file:/C:Documents%20and%20Settings

6、Administrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115747#_Toc2661157473.1 用例圖 PAGEREF _Toc266115747 h 5HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115748#_Toc2661157483.2 功能設(shè)計(jì)說明 PAGEREF _Toc266115748 h 5HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc2661157

7、49#_Toc2661157493.2.1 模塊1 PAGEREF _Toc266115749 h 5HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115750#_Toc2661157503.2.2 模塊2 PAGEREF _Toc266115750 h 6HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115751#_Toc2661157514. 接口設(shè)計(jì) PAGEREF _Toc

8、266115751 h 7HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115752#_Toc2661157524.1 部接口 PAGEREF _Toc266115752 h 7HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115753#_Toc2661157534.2 外部接口 PAGEREF _Toc266115753 h 7HYPERLINK file:/C:Document

9、s%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115754#_Toc2661157544.2.1 接口說明 PAGEREF _Toc266115754 h 7HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115755#_Toc2661157554.2.2 調(diào)用方式 PAGEREF _Toc266115755 h 8HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳

10、細(xì)設(shè)計(jì).doc l _Toc266115756#_Toc2661157565. 數(shù)據(jù)庫設(shè)計(jì) PAGEREF _Toc266115756 h 8HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115757#_Toc2661157576. 系統(tǒng)安全設(shè)計(jì) PAGEREF _Toc266115757 h 8HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115758#_Toc266115758

11、6.1 說明 PAGEREF _Toc266115758 h 8HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115759#_Toc2661157596.2 設(shè)計(jì) PAGEREF _Toc266115759 h 8HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115760#_Toc2661157606.2.1 數(shù)據(jù)傳輸部分 PAGEREF _Toc266115760 h 8HYPE

12、RLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115761#_Toc2661157616.2.2 IP過濾分部 PAGEREF _Toc266115761 h 8HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115762#_Toc2661157626.2.3 身份驗(yàn)證部分 PAGEREF _Toc266115762 h 8HYPERLINK file:/C:Documents%20and%

13、20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115763#_Toc2661157637. 系統(tǒng)性能設(shè)計(jì) PAGEREF _Toc266115763 h 9HYPERLINK file:/C:Documents%20and%20SettingsAdministrator桌面詳細(xì)設(shè)計(jì).doc l _Toc266115764#_Toc2661157648. 系統(tǒng)出錯(cuò)處理 PAGEREF _Toc266115764 h 9引言背景此文檔的背景編寫目的和圍說明寫這份詳細(xì)設(shè)計(jì)說明書的目的。本詳細(xì)設(shè)計(jì)說明書編寫的目的是說明程序模塊的設(shè)計(jì)考慮，包括程序描述、輸入/輸出

14、、算法和流程邏輯等，為軟件編程和系統(tǒng)維護(hù)提供基礎(chǔ)。本說明書的預(yù)期讀者為系統(tǒng)設(shè)計(jì)人員、軟件開發(fā)人員、軟件測試人員和項(xiàng)目評審人員。術(shù)語表定義系統(tǒng)或產(chǎn)品中涉及的重要術(shù)語，為讀者在閱讀文檔時(shí)提供必要的參考信息。序號(hào)術(shù)語或縮略語說明性定義1PMProject Manager,項(xiàng)目經(jīng)理2參考資料列出有關(guān)資料的名稱、作者、文件編號(hào)或版本等。參考資料包括：a需求說明書、架構(gòu)設(shè)計(jì)說明書等；b本項(xiàng)目的其他已發(fā)表的文件；c引用文件、資料、軟件開發(fā)標(biāo)準(zhǔn)等。資料名稱作者文件編號(hào)、版本資料存放地點(diǎn)使用的文字處理和繪圖工具文字處理軟件：編寫設(shè)計(jì)文檔使用的文字處理軟件，如RedOffice 繪圖工具：使用的UML工具，如Ro

15、se、Jude、Visio設(shè)計(jì)概述任務(wù)和目標(biāo)需求概述運(yùn)行環(huán)境概述條件與限制詳細(xì)設(shè)計(jì)方法和工具系統(tǒng)詳細(xì)需求分析主要對系統(tǒng)級的需求進(jìn)行分析。首先應(yīng)對需求分析提出的企業(yè)需求進(jìn)一步確認(rèn)，并對由于情況變化而帶來的需求變化進(jìn)行較為詳細(xì)的分析。詳細(xì)需求分析詳細(xì)功能需求分析詳細(xì)性能需求分析詳細(xì)資源需求分析詳細(xì)接口需求分析詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析總體方案確認(rèn)著重解決系統(tǒng)總體結(jié)構(gòu)確認(rèn)及界面劃分問題。系統(tǒng)總體結(jié)構(gòu)確認(rèn)對系統(tǒng)組成、邏輯結(jié)構(gòu)及層次進(jìn)行確認(rèn)，對應(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)變化。包括：系統(tǒng)組成、邏輯

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

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

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

19、括功能和數(shù)據(jù)接口）進(jìn)行設(shè)計(jì)。部界面設(shè)計(jì)設(shè)計(jì)系統(tǒng)部各功能模塊間的調(diào)用關(guān)系和數(shù)據(jù)接口。用戶界面設(shè)計(jì)規(guī)定人機(jī)界面的容、界面風(fēng)格、調(diào)用方式等，包括所謂的表單設(shè)計(jì)、報(bào)表設(shè)計(jì)和用戶需要的打印輸出等設(shè)計(jì)。此部分容可能比較多。開發(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 & production environment: OS, da

20、tabase - .net framwork 4.0Windwos 2003, iis 6.0, MySQL, 模塊設(shè)計(jì)用例圖功能設(shè)計(jì)說明模塊1模塊1主要分為以下幾個(gè)子模塊：子模塊1、子模塊2和子模塊N。子模塊1設(shè)計(jì)圖功能描述簡要描述子模塊1的業(yè)務(wù)功能。輸入數(shù)據(jù)詳細(xì)描述用戶輸入的數(shù)據(jù)(包括任何輸入設(shè)備)以及這些數(shù)據(jù)的有效性檢驗(yàn)規(guī)則。詳細(xì)描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。輸出數(shù)據(jù)詳細(xì)描述子功能1所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。業(yè)務(wù)算法和流程從業(yè)務(wù)角度詳細(xì)描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流程。數(shù)據(jù)設(shè)計(jì)給出本程序中的局部數(shù)據(jù)結(jié)構(gòu)說明，包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說明，具體

21、數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋設(shè)計(jì)、取值）等。相關(guān)數(shù)據(jù)庫表，數(shù)據(jù)存儲(chǔ)設(shè)計(jì)（具體說明需要以文件方式保存的數(shù)據(jù)文件名、數(shù)據(jù)存儲(chǔ)格式、數(shù)據(jù)項(xiàng)及屬性等。）源程序文件說明給出本程序的各源程序文件的說明，包括源程序文件名稱及其所在目錄，功能說明，包含的前導(dǎo)文件及函數(shù)名稱等。函數(shù)說明具體說明本程序中的各個(gè)函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局變量，局部變量，返回值，算法說明，使用約束等。限制條件其他說明模塊2模塊1主要分為以下幾個(gè)子模塊：子模塊1、子模塊2和子模塊N。子模塊1設(shè)計(jì)圖功能描述簡要描述子模塊1的業(yè)務(wù)功能。輸入數(shù)據(jù)詳細(xì)描述用戶輸入的數(shù)據(jù)(包括任何輸入設(shè)備)以及這些數(shù)據(jù)的有效性檢驗(yàn)規(guī)則。詳

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

23、全局變量，局部變量，返回值，算法說明，使用約束等。限制條件其他說明接口設(shè)計(jì)部接口外部接口接口說明例如：*子系統(tǒng)通過*從*子系統(tǒng)取得*等，相關(guān)標(biāo)準(zhǔn)，調(diào)用示例，可根據(jù)需要增加章節(jié)描述接口。調(diào)用方式例如：部接口調(diào)用：例: /*通過用戶服務(wù)取得該客戶認(rèn)證密碼等信息，如果該客戶存在返回為0，其他情況參考錯(cuò)誤編碼*/public RUserInfo getUserInfo (String userNo);數(shù)據(jù)庫設(shè)計(jì)詳見*數(shù)據(jù)庫設(shè)計(jì)說明書如果數(shù)據(jù)庫設(shè)計(jì)容比較少，則直接在此處描述。系統(tǒng)安全設(shè)計(jì)說明例如：由于存在與外部系統(tǒng)的接口,所以需要考慮訪問安全的問題.設(shè)計(jì)例如：分為數(shù)據(jù)傳輸部分,IP過濾部分,身份驗(yàn)證部分

24、.章節(jié)可補(bǔ)充數(shù)據(jù)傳輸部分例如：在部分?jǐn)?shù)據(jù)傳遞的時(shí)候,考慮以https協(xié)議,需要在部署的時(shí)候作相關(guān)處理.IP過濾分部例如：可在系統(tǒng)前端通過Filter實(shí)現(xiàn),該Filter實(shí)現(xiàn)對該地址訪問的IP過濾作用.可信任IP地址通過*ml文件進(jìn)行配置.身份驗(yàn)證部分例如：對信任的用戶,頒發(fā)身份驗(yàn)證碼,通過該標(biāo)識(shí)進(jìn)行身份識(shí)別.系統(tǒng)性能設(shè)計(jì)系統(tǒng)出錯(cuò)處理例如：為了在系統(tǒng)出現(xiàn)異常情況下給用戶以明確的提示，可采用兩種方式予以提示：1使用Javascript的alert()函數(shù)直接提示，這主要在輸入或修改的情況下使用；2使用統(tǒng)一的錯(cuò)誤界面提示，該界面對應(yīng)于errorpage.jsp頁面。錯(cuò)誤界面樣式如下圖所示：錯(cuò)誤提示界面設(shè)計(jì)和開發(fā)規(guī)【可以列表方式列出設(shè)計(jì)開發(fā)的參考文檔的索引，容較少/關(guān)鍵容可以章節(jié)方式填寫】數(shù)據(jù)庫設(shè)計(jì)規(guī)【參見*數(shù)據(jù)庫設(shè)計(jì)規(guī)】.NET編碼規(guī)特別強(qiáng)調(diào)：詳細(xì)請參見ASP.Net文檔規(guī)這里只做簡單闡述，如有變動(dòng)，會(huì)及時(shí)同事整個(gè)項(xiàng)目組相關(guān)人員。(1)不要給類名加前綴。使用PascalCasing風(fēng)格，不使用匈牙利命名法 。 (2)要用名詞詞組來給類型命名。使用PascalCasing風(fēng)格 。 (3)類名少用縮寫,不要使用下劃線字符 (_)。 (4)基類CBase的文件名為：FileBase.cs;(5) 泛型類命名：考慮用T來命名參數(shù)類型 ，類如：public class List。(6)接口（