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

1、精選優(yōu)質(zhì)文檔-傾情為你奉上研發(fā)生產(chǎn)中心文檔編號(hào)版本A1密級(jí)商密A項(xiàng)目名稱(chēng)XX系統(tǒng)項(xiàng)目來(lái)源QR-RD-022(Ver1.2) Xxx系統(tǒng)詳細(xì)設(shè)計(jì)說(shuō)明書(shū) (內(nèi)部資料 請(qǐng)勿外傳)編 寫(xiě)：日 期：檢 查：日 期：審 核：日 期：批 準(zhǔn)：日 期：XX公司版權(quán)所有 不得復(fù)制文檔變更記錄序號(hào)變更（+/-）說(shuō)明作者版本號(hào)日期批準(zhǔn)12目 錄1. 引言1.1 編寫(xiě)目的和范圍說(shuō)明寫(xiě)這份詳細(xì)設(shè)計(jì)說(shuō)明書(shū)的目的。本詳細(xì)設(shè)計(jì)說(shuō)明書(shū)編寫(xiě)的目的是說(shuō)明程序模塊的設(shè)計(jì)考慮，包括程序描述、輸入/輸出、算法和流程邏輯等，為軟件編程和系統(tǒng)維護(hù)提供基礎(chǔ)。本說(shuō)明書(shū)的預(yù)期讀者為系統(tǒng)設(shè)計(jì)人員、軟件開(kāi)發(fā)人員、軟件測(cè)試人員和項(xiàng)目評(píng)審人員。1.2 術(shù)

2、語(yǔ)表定義系統(tǒng)或產(chǎn)品中涉及的重要術(shù)語(yǔ)，為讀者在閱讀文檔時(shí)提供必要的參考信息。序號(hào)術(shù)語(yǔ)或縮略語(yǔ)說(shuō)明性定義1PMProject Manager,項(xiàng)目經(jīng)理21.3 參考資料列出有關(guān)資料的名稱(chēng)、作者、文件編號(hào)或版本等。參考資料包括：a需求說(shuō)明書(shū)、架構(gòu)設(shè)計(jì)說(shuō)明書(shū)等；b本項(xiàng)目的其他已發(fā)表的文件；c引用文件、資料、軟件開(kāi)發(fā)標(biāo)準(zhǔn)等。 資料名稱(chēng)作者文件編號(hào)、版本資料存放地點(diǎn)1.4 使用的文字處理和繪圖工具文字處理軟件：編寫(xiě)設(shè)計(jì)文檔使用的文字處理軟件，如RedOffice 繪圖工具：使用的UML工具，如Rose、Jude、Visio2. 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說(shuō)明本章說(shuō)明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。2.1

3、 常量包括數(shù)據(jù)文件名稱(chēng)及其所在目錄，功能說(shuō)明，具體常量說(shuō)明等。2.2 變量本章說(shuō)明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。2.3 數(shù)據(jù)結(jié)構(gòu)包括數(shù)據(jù)結(jié)構(gòu)名稱(chēng)，功能說(shuō)明，具體數(shù)據(jù)結(jié)構(gòu)說(shuō)明（定義、注釋、取值）等。3. 模塊設(shè)計(jì)3.1 用例圖3.2 功能設(shè)計(jì)說(shuō)明3.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)規(guī)則。詳細(xì)描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的

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

5、數(shù)，包括函數(shù)名稱(chēng)及其所在文件，功能，格式，參數(shù)，全局變量，局部變量，返回值，算法說(shuō)明，使用約束等。.9 限制條件.10 其他說(shuō)明3.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ù)以及獲取這些數(shù)據(jù)的條件。.4 輸出數(shù)據(jù)詳細(xì)描述子功能1所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。.5

6、業(yè)務(wù)算法和流程從業(yè)務(wù)角度詳細(xì)描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流程。.6 數(shù)據(jù)設(shè)計(jì)給出本程序中的局部數(shù)據(jù)結(jié)構(gòu)說(shuō)明，包括數(shù)據(jù)結(jié)構(gòu)名稱(chēng)，功能說(shuō)明，具體數(shù)據(jù)結(jié)構(gòu)說(shuō)明（定義、注釋設(shè)計(jì)、取值）等。相關(guān)數(shù)據(jù)庫(kù)表，數(shù)據(jù)存儲(chǔ)設(shè)計(jì)（具體說(shuō)明需要以文件方式保存的數(shù)據(jù)文件名、數(shù)據(jù)存儲(chǔ)格式、數(shù)據(jù)項(xiàng)及屬性等。）.7 源程序文件說(shuō)明給出本程序的各源程序文件的說(shuō)明，包括源程序文件名稱(chēng)及其所在目錄，功能說(shuō)明，包含的前導(dǎo)文件及函數(shù)名稱(chēng)等。.8 函數(shù)說(shuō)明具體說(shuō)明本程序中的各個(gè)函數(shù)，包括函數(shù)名稱(chēng)及其所在文件，功能，格式，參數(shù)，全局變量，局部變量，返回值，算法說(shuō)明，使用約束等。3.2.

7、2.1.9 限制條件.10 其他說(shuō)明4. 接口設(shè)計(jì)4.1 內(nèi)部接口4.2 外部接口4.2.1 接口說(shuō)明例如：xx子系統(tǒng)通過(guò)xx從xx子系統(tǒng)取得xx等，相關(guān)標(biāo)準(zhǔn)，調(diào)用示例，可根據(jù)需要增加章節(jié)描述接口。4.2.2 調(diào)用方式例如：內(nèi)部接口調(diào)用：例: /*通過(guò)用戶服務(wù)號(hào)碼取得該客戶認(rèn)證密碼等信息，如果該客戶存在返回為0，其他情況參考錯(cuò)誤編碼*/public RUserInfo getUserInfo (String userNo);5. 數(shù)據(jù)庫(kù)設(shè)計(jì)詳見(jiàn)xxx數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)如果數(shù)據(jù)庫(kù)設(shè)計(jì)內(nèi)容比較少，則直接在此處描述。6. 系統(tǒng)安全保密設(shè)計(jì)6.1 說(shuō)明例如：由于存在與外部系統(tǒng)的接口,所以需要考慮訪問(wèn)安全的問(wèn)題.6.2 設(shè)計(jì)例如：分為數(shù)據(jù)傳輸部分,IP過(guò)濾部分,身份驗(yàn)證部分.章節(jié)可補(bǔ)充6.2.1 數(shù)據(jù)傳輸部分例如：在部分?jǐn)?shù)據(jù)傳遞的時(shí)候,考慮以https協(xié)議,需要在部署的時(shí)候作相關(guān)處理.6.2.2 IP過(guò)濾分部例如：可在系統(tǒng)前端通過(guò)Filter實(shí)現(xiàn),該Filter實(shí)現(xiàn)對(duì)該地址訪問(wèn)的IP過(guò)濾作用.可信任IP地址通過(guò)xml文件進(jìn)行配置.6.2.3 身份驗(yàn)證部分例如：對(duì)信任的用戶,頒發(fā)身份驗(yàn)證碼,通過(guò)該標(biāo)識(shí)進(jìn)行身份識(shí)別.7. 系統(tǒng)性能設(shè)計(jì)8. 系統(tǒng)出錯(cuò)處理例如：為了在系統(tǒng)出現(xiàn)異常情況下給用戶以