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

1、研發(fā)生產(chǎn)中心文檔編號版本A1密級商密 A項(xiàng)目名稱Xx 系統(tǒng)項(xiàng)目來源QR-RD-022Xxx 系統(tǒng)詳細(xì)設(shè)計(jì)說明書（ 內(nèi)部資料 請勿外傳 ）期：期：期：期：編檢審批XX公司版權(quán)所有 不得復(fù)制文檔變更記錄序號變更（ +/- ）說明作者版本號日期批準(zhǔn)12目錄1. 引言 錯(cuò)誤!未定義書簽。編寫目的和范圍 . 錯(cuò)誤 !未定義書簽。術(shù)語表 . 錯(cuò)誤 ! 未定義書簽。參考資料 . 錯(cuò)誤 !未定義書簽。使用的文字處理和繪圖工具 . 錯(cuò)誤 !未定義書簽。2. 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說明 . 錯(cuò)誤!未定義書簽。常量 錯(cuò)誤 !未定義書簽。變量 錯(cuò)誤 !未定義書簽。數(shù)據(jù)結(jié)構(gòu) . 錯(cuò)誤 !未定義書簽。3. 模塊設(shè)計(jì) . 錯(cuò)誤 !未

2、定義書簽。用例圖 . 錯(cuò)誤 !未定義書簽。功能設(shè)計(jì)說明 . 錯(cuò)誤 !未定義書簽。模塊 1 錯(cuò)誤 !未定義書簽。模塊 2 錯(cuò)誤 !未定義書簽。4. 接口設(shè)計(jì) . 錯(cuò)誤 ! 未定義書簽。內(nèi)部接口 . 錯(cuò)誤 ! 未定義書簽。外部接口 . 錯(cuò)誤 !未定義書簽。接口說明 . 錯(cuò)誤 ! 未定義書簽。調(diào)用方式 . 錯(cuò)誤 !未定義書簽。5. 數(shù)據(jù)庫設(shè)計(jì) . 錯(cuò)誤 !未定義書簽。6. 系統(tǒng)安全保密設(shè)計(jì) . 錯(cuò)誤 !未定義書簽。說明 錯(cuò)誤 !未定義書簽。設(shè)計(jì) 錯(cuò)誤 !未定義書簽。數(shù)據(jù)傳輸部分 . 錯(cuò)誤 !未定義書簽。IP 過濾分部 錯(cuò)誤 ! 未定義書簽。身份驗(yàn)證部分 . 錯(cuò)誤 ! 未定義書簽。7. 系統(tǒng)性能設(shè)計(jì)

3、. 錯(cuò)誤 ! 未定義書簽。8. 系統(tǒng)出錯(cuò)處理 . 錯(cuò)誤 ! 未定義書簽。1. 引言1.1 編寫目的和范圍說明寫這份詳細(xì)設(shè)計(jì)說明書的目的。本詳細(xì)設(shè)計(jì)說明書編寫的目的是說明程序模塊的設(shè)計(jì)考慮， 包括程序描述、輸入/ 輸出、 算法和流程邏輯等，為軟件編程和系統(tǒng)維護(hù)提供基礎(chǔ)。 本說明書的預(yù)期讀者為系統(tǒng)設(shè)計(jì)人員、 軟件開發(fā)人員、軟件測試人員和項(xiàng)目評審人員。1.2 術(shù)語表定義系統(tǒng)或產(chǎn)品中涉及的重要術(shù)語，為讀者在閱讀文檔時(shí)提供必要的參考信息序號術(shù)語或縮略語說明性定義1PMProject Manager, 項(xiàng)目經(jīng)理21.3 參考資料列出有關(guān)資料的名稱、作者、文件編號或版本等。參考資料包括： a需求說明書、架構(gòu)

4、設(shè)計(jì)說明書等； b本項(xiàng)目的其他已發(fā)表的文件； c引用文件、資料、軟件開發(fā)標(biāo)準(zhǔn)等。資料名稱作者文件編號、版本資料存放地點(diǎn)1.4 使用的文字處理和繪圖工具文字處理軟件： 編寫設(shè)計(jì)文檔使用的文字處理軟件，如 RedOffice 繪圖工具： 使用的 UML工具，如 Rose、Jude、Visio2. 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說明本章說明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。2.1 常量包括數(shù)據(jù)文件名稱及其所在目錄，功能說明，具體常量說明等。2.2 變量本章說明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。2.3 數(shù)據(jù)結(jié)構(gòu)包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋、取值）等。3. 模塊設(shè)計(jì)

5、3.1 用例圖3.2 功能設(shè)計(jì)說明模塊 1模塊 1主要分為以下幾個(gè)子模塊：子模塊 1、子模塊 2 和子模塊 N。 子模塊 .1 設(shè)計(jì)圖.2 功能描述簡要描述子模塊 1 的業(yè)務(wù)功能。.3 輸入數(shù)據(jù)詳細(xì)描述用戶輸入的數(shù)據(jù) （ 包括任何輸入設(shè)備 ） 以及這些數(shù)據(jù)的有效性檢驗(yàn)規(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ì)給

6、出本程序中的局部數(shù)據(jù)結(jié)構(gòu)說明， 包括數(shù)據(jù)結(jié)構(gòu)名稱， 功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋設(shè)計(jì)、取值）等。相關(guān)數(shù)據(jù)庫表，數(shù)據(jù)存儲設(shè)計(jì)（具體說明需要以文件方式保 存的數(shù)據(jù)文件名、數(shù)據(jù)存儲格式、數(shù)據(jù)項(xiàng)及屬性等。 ）.7 源程序文件說明給出本程序的各源程序文件的說明， 包括源程序文件名稱及其所在目錄， 功能說明， 包 含的前導(dǎo)文件及函數(shù)名稱等。.8 函數(shù)說明具體說明本程序中的各個(gè)函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局 變量，局部變量，返回值，算法說明，使用約束等。.9 限制條件.10 其他說明模塊 2模塊 1主要分為以下幾個(gè)子模

7、塊：子模塊 1、子模塊 2 和子模塊 N。 子模塊 .1 設(shè)計(jì)圖.2 功能描述 簡要描述子模塊 1 的業(yè)務(wù)功能。.3 輸入數(shù)據(jù)詳細(xì)描述用戶輸入的數(shù)據(jù) （ 包括任何輸入設(shè)備 ） 以及這些數(shù)據(jù)的有效性檢驗(yàn)規(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)名稱， 功能說明，

8、具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋設(shè)計(jì)、取值）等。相關(guān)數(shù)據(jù)庫表，數(shù)據(jù)存儲設(shè)計(jì)（具體說明需要以文件方式保 存的數(shù)據(jù)文件名、數(shù)據(jù)存儲格式、數(shù)據(jù)項(xiàng)及屬性等。 ）源程序文件說明給出本程序的各源程序文件的說明， 包括源程序文件名稱及其所在目錄， 含的前導(dǎo)文件及函數(shù)名稱等。函數(shù)說明具體說明本程序中的各個(gè)函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式， 變量，局部變量，返回值，算法說明，使用約束等。限制條件其他說明功能說明，包參數(shù)，全局4. 接口設(shè)計(jì)4.1 內(nèi)部接口4.2 外部接口接口說明例如：xx子系統(tǒng)通過 xx 從xx 子系統(tǒng)取得 xx 等，相關(guān)標(biāo)準(zhǔn)，調(diào)用示例， 加章節(jié)描述接口。可根據(jù)需要增調(diào)用方式例如：內(nèi)部接口

9、調(diào)用：例:/*通過用戶服務(wù)號碼取得該客戶認(rèn)證密碼等信息，如果該客戶存在返回為0，其他情況參考錯(cuò)誤編碼*/public RUserInfo getUserInfo (String userNo);5. 數(shù)據(jù)庫設(shè)計(jì)詳見 xxx 數(shù)據(jù)庫設(shè)計(jì)說明書 如果數(shù)據(jù)庫設(shè)計(jì)內(nèi)容比較少，則直接在此處描述。6. 系統(tǒng)安全保密設(shè)計(jì)6.1 說明例如：由于存在與外部系統(tǒng)的接口 , 所以需要考慮訪問安全的問題 .6.2 設(shè)計(jì)例如：分為數(shù)據(jù)傳輸部分 ,IP 過濾部分,身份驗(yàn)證部分 . 章節(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 地址通過 xml 文件進(jìn)行配置 .6.2.3 身份驗(yàn)證部分例如：對信任的用戶 ,頒發(fā)身份驗(yàn)證碼 ,通過該標(biāo)識進(jìn)行身份識別 .7. 系統(tǒng)性能設(shè)計(jì)8