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

1、For pers onal use only in study and research; not for commercial use蚃 For pers onal use only in study and research; not for commercial use螀蟻研發(fā)生產(chǎn)中心莈文檔編 號(hào)蚅袀版 本螇A1祎密 級(jí)蒄商密A膈項(xiàng)目名 稱薈XX系統(tǒng)芄項(xiàng)目來 源蕿羆 QR-RD-022(Ver1.2)螈Xxx系統(tǒng)羅詳細(xì)設(shè)計(jì)說明書蒃莁膆螄蒃薃（內(nèi)部資料請(qǐng)勿外傳）薃衿編 寫：蒞薆日期:芀檢 查： 肇莄日期:蝕審 核： 薅肅日期:袇批 準(zhǔn)：芇袂日期:肀XX公司蒃版權(quán)所有不得復(fù)制膂薇文檔變更記錄

2、蒆序號(hào)節(jié)變更（+/-）說明薈作者艿版本號(hào)芅日期莂批準(zhǔn)罿1螆肅蒂荿蒈螂2薂螀羆裊螞羇蚈薄蟻莈肆莃螁蝿螈莆袁膀芆膅羈薁羈羄螁莇肅莂螁螈袇蒞袀腿芅膄羀薀羇羃肀羆目錄膀1. 引言 7肈1.1 編寫目的和范圍 7膇1.2 術(shù)語表 7螅1.3 參考資料 8芀1.4 使用的文字處理和繪圖工具 8葿2. 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說明 8袈2.1 常量 8薃2.2 變量 8芀2.3 數(shù)據(jù)結(jié)構(gòu) 9衿3. 模塊設(shè)計(jì) 9莆3.1 用例圖 9節(jié)3.2 功能設(shè)計(jì)說明 9莀3.2.1 模塊 1 9芀 3.2.2 模塊 2 10肈 4. 接口設(shè)計(jì) 11蒞4.1 內(nèi)部接口 11蒀4.2 外部接口 11蕆4.2.1 接口說明 11蒆4.2.

3、2 調(diào)用方式 11肄 5. 數(shù)據(jù)庫(kù)設(shè)計(jì) 11蕿6. 系統(tǒng)安全保密設(shè)計(jì) 11袈6.1 說明 11羋6.2 設(shè)計(jì) 12袃6.2.1 數(shù)據(jù)傳輸部分 12羃 6.2.2 IP 過濾分部 12艿6.2.3 身份驗(yàn)證部分 12蚆 7. 系統(tǒng)性能設(shè)計(jì) 12袆8. 系統(tǒng)出錯(cuò)處理 12羃1.2. 莈引言2.12.2蚅編寫目的和范圍肅說明寫這份詳細(xì)設(shè)計(jì)說明書的目的。肁本詳細(xì)設(shè)計(jì)說明書編寫的目的是說明程序模塊的設(shè)計(jì)考慮，包括程序描述、輸入/輸出、算法和流程邏輯等，為軟件編程和系統(tǒng)維護(hù)提供基礎(chǔ)。本說明書的預(yù)期讀者為系統(tǒng)設(shè)計(jì) 人員、軟件開發(fā)人員、軟件測(cè)試人員和項(xiàng)目評(píng)審人員。2.32.4裊術(shù)語表蒄定義系統(tǒng)或產(chǎn)品中涉及的重

4、要術(shù)語，為讀者在閱讀文檔時(shí)提供必要的參考信息膃序號(hào)膈術(shù)語或縮略語薇說明性定義膂1芃PM薈Project Man ager,項(xiàng)目經(jīng)理肅2芅莃罿螇羄蒃2.52.6莀參考資料膅列出有關(guān)資料的名稱、作者、文件編號(hào)或版本等。參考資料包括:螃a.需求說明書、架構(gòu)設(shè)計(jì)說明書等；薂b本項(xiàng)目的其他已發(fā)表的文件；蕆c .引用文件、資料、軟件開發(fā)標(biāo)準(zhǔn)等。袇資料名稱薂作者薂文件編號(hào)、版本袈資料存放地點(diǎn)蒞薅螞艿肇2.7使用的文字處理和繪圖工具文字處理軟件：編寫設(shè)計(jì)文檔使用的文字處理軟件，如 RedOffice 繪圖工具：使用的UML工具，女口 Rose Jude、Visio3. 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說明本章說明本程序系統(tǒng)中使用

5、的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。3.1常量包括數(shù)據(jù)文件名稱及其所在目錄，功能說明，具體常量說明等。3.2變量本章說明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)3.3 數(shù)據(jù)結(jié)構(gòu)包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋、取值）等。4. 模塊設(shè)計(jì)4.1 用例圖4.2 功能設(shè)計(jì)說明4.2.1 模塊 1模塊 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)

6、規(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)說明， 包括數(shù)據(jù)結(jié)構(gòu)名稱， 功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋設(shè)計(jì)、取值）等。相關(guān)數(shù)據(jù)庫(kù)表，數(shù)據(jù)存儲(chǔ)設(shè)計(jì)（具體說明需要以文件方式保 存的數(shù)據(jù)文件名、數(shù)據(jù)存儲(chǔ)格式、數(shù)據(jù)項(xiàng)及屬性等。 ）.7 源程序文件說明給出本程序的各源程序文件的說明， 包括源程序文件名稱及其所在目錄， 功能說明，

7、包 含的前導(dǎo)文件及函數(shù)名稱等。.8 函數(shù)說明具體說明本程序中的各個(gè)函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局 變量，局部變量，返回值，算法說明，使用約束等。.9 限制條件.10 其他說明4.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ù)以及獲取這些

8、數(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)說明， 包括數(shù)據(jù)結(jié)構(gòu)名稱， 功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明 （定義、注釋設(shè)計(jì)、取值）等。相關(guān)數(shù)據(jù)庫(kù)表，數(shù)據(jù)存儲(chǔ)設(shè)計(jì)（具體說明需要以文件方式保 存的數(shù)據(jù)文件名、數(shù)據(jù)存儲(chǔ)格式、數(shù)據(jù)項(xiàng)及屬性等。 ）.7 源程序文件說明給出本程序的各源程序文件的說明， 包括源程序文件名稱及其所在目錄， 功能說明， 包 含的前導(dǎo)文件及函數(shù)名稱等。.8 函數(shù)

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

10、 XXX 數(shù)據(jù)庫(kù)設(shè)計(jì)說明書 如果數(shù)據(jù)庫(kù)設(shè)計(jì)內(nèi)容比較少，則直接在此處描述。7. 系統(tǒng)安全保密設(shè)計(jì)7.1 說明例如：由于存在與外部系統(tǒng)的接口 , 所以需要考慮訪問安全的問題7.2設(shè)計(jì)例如：分為數(shù)據(jù)傳輸部分，ip過濾部分,身份驗(yàn)證部分.章節(jié)可補(bǔ)充7.2.1數(shù)據(jù)傳輸部分例如：在部分?jǐn)?shù)據(jù)傳遞的時(shí)候,考慮以https協(xié)議，需要在部署的時(shí)候作相關(guān)處理.7.2.2 IP過濾分部例如：可在系統(tǒng)前端通過Filter實(shí)現(xiàn),該Filter實(shí)現(xiàn)對(duì)該地址訪問的IP過濾作用.可 信任IP地址通過xml文件進(jìn)行配置.7.2.3身份驗(yàn)證部分例如：對(duì)信任的用戶，頒發(fā)身份驗(yàn)證碼,通過該標(biāo)識(shí)進(jìn)行身份識(shí)別.8. 系統(tǒng)性能設(shè)計(jì)9. 系統(tǒng)

11、出錯(cuò)處理例如：為了在系統(tǒng)出現(xiàn)異常情況下給用戶以明確的提示，可采用兩種方式予以提示：1. 使用Javascript的alert()函數(shù)直接提示，這主要在輸入或修改的情況下使用；2. 使用統(tǒng)一的錯(cuò)誤界面提示，該界面對(duì)應(yīng)于 errorpage.jsp 頁面。錯(cuò)誤界面樣式如下圖所示：錯(cuò)誤提示："錯(cuò)誤提示內(nèi)容”返回錯(cuò)誤提示界面僅供個(gè)人用于學(xué)習(xí)、研究；不得用于商業(yè)用途For personal use only in study and research; not for commercial use.Nur f u r den pers?nlichen f u r Studien, Forsch

12、ung, zu kommerziellen Zwecken verwendet werden.Pour l ' e tude et la recherche uniquementa des fins personnelles; pasa des fins commerciales.to員bko gA.nrogeHKO TOpMenob3ymrnflCH6yHeHuac egoB u HHuefigoHMUCnO 員 B30BaTbCEb KOMMepqeckuxue 貝 ex.以下無正文僅供個(gè)人用于學(xué)習(xí)、研究；不得用于商業(yè)用途For personal use only in study and research; not for commercial use.Nur f u r den pers?nlichen fu r Studien, Forschung, zu kommerziellen Zwecken verwendet werden.Pour l ' e tude et la recherche uniquementa des fins personnelles;