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

1、 香港服裝學(xué)院服裝 CAD 系統(tǒng) 詳細(xì)設(shè)計(jì)說(shuō)明書(內(nèi)部資料 請(qǐng)勿外傳 編 寫:陳文兵 日 期:20121201 檢 查:日 期:審 核:日 期:批 準(zhǔn):日 期:香 港 服 裝 學(xué) 院版權(quán)所有 不得復(fù)制文檔變更記錄 目 錄1. 引言 .4 1.1 編寫目的和范圍 . .4 1.2 術(shù)語(yǔ)表 . .4 1.3 參考資料 .41.4 使用的文字處理和繪圖工具 .42. 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說(shuō)明 .4 2.1 常量 .5 2.2 變量 .52.3 數(shù)據(jù)結(jié)構(gòu) .53. 模塊設(shè)計(jì) .5 3.1 用例圖 . .5 3.2 功能設(shè)計(jì)說(shuō)明 .5 3.2.1 模塊 1 .53.2.2 模塊 2 .64. 接口設(shè)計(jì) .7 4

2、.1 內(nèi)部接口 .7 4.2 外部接口 .7 4.2.1 接口說(shuō)明 . .74.2.2 調(diào)用方式 . .75. 數(shù)據(jù)庫(kù)設(shè)計(jì) .76. 系統(tǒng)安全保密設(shè)計(jì) .8 6.1 說(shuō)明 .8 6.2 設(shè)計(jì) .8 6.2.1 數(shù)據(jù)傳輸部分 . .8 6.2.2 IP過(guò)濾分部 . .86.2.3 身份驗(yàn)證部分 . .87. 系統(tǒng)性能設(shè)計(jì) .88. 系統(tǒng)出錯(cuò)處理 .81. 引言說(shuō)明寫這份詳細(xì)設(shè)計(jì)說(shuō)明書的目的。本詳細(xì)設(shè)計(jì)說(shuō)明書編寫的目的是說(shuō)明程序模塊的設(shè)計(jì)考慮, 包括程序描述、 輸入 /輸出、 算法和流程邏輯等, 為軟件編程和系統(tǒng)維護(hù)提供基礎(chǔ)。 本說(shuō)明書的預(yù)期讀者為系統(tǒng)設(shè)計(jì)人員、 軟件開發(fā)人員、軟件測(cè)試人員和項(xiàng)目評(píng)

3、審人員。 列出有關(guān)資料的名稱、作者、文件編號(hào)或版本等。參考資料包括:a .需求說(shuō)明書、架構(gòu)設(shè)計(jì)說(shuō)明書等;b .本項(xiàng)目的其他已發(fā)表的文件;c .引用文件、資料、軟件開發(fā)標(biāo)準(zhǔn)等。 文字處理軟件:編寫設(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)。包括數(shù)據(jù)文件名稱及其所在目錄,功能說(shuō)明,具體常量說(shuō)明等。本章說(shuō)明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。包括數(shù)據(jù)結(jié)構(gòu)名稱,功能說(shuō)明,具體數(shù)據(jù)結(jié)構(gòu)說(shuō)明(定義、注釋、取值等。 3. 模塊設(shè)計(jì)3.2.

4、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 輸出數(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ù)

5、結(jié)構(gòu)名稱，功能說(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ō)明，包括源程序文件名稱及其所在目錄，功能說(shuō)明，包 含的前導(dǎo)文件及函數(shù)名稱等。 .8 函數(shù)說(shuō)明 具體說(shuō)明本程序中的各個(gè)函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局 變量，局部變量，返回值，算法說(shuō)明，使用約束等。 .9 限制條件 .10 其他說(shuō)明 3.2.2 模塊 2 模塊 1 主要分為以下幾個(gè)子模塊：子模塊 1、

6、子模塊 2 和子模塊 N。 子模塊 1 .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 業(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)名稱，功能說(shuō)明，具體數(shù)據(jù)結(jié)構(gòu)

7、說(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ō)明，包括源程序文件名稱及其所在目錄，功能說(shuō)明，包 含的前導(dǎo)文件及函數(shù)名稱等。 .8 函數(shù)說(shuō)明 具體說(shuō)明本程序中的各個(gè)函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局 變量，局部變量，返回值，算法說(shuō)明，使用約束等。 .9 限制條件 .10 其他說(shuō)明 4. 接口設(shè)計(jì) 4.1 內(nèi)部接口 4.2 外部接口 4.2.1 接口說(shuō)明 例如：xx 子系統(tǒng)通過(guò) x

8、x 從 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ì) 詳見xxx 數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書 如果數(shù)據(jù)庫(kù)設(shè)計(jì)內(nèi)容比較少，則直接在此處描述。 6. 系統(tǒng)安全保密設(shè)計(jì) 6.1 說(shuō)明 例如：由于存在與外部系統(tǒng)的接口,所以需要考慮訪問安全的問題. 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ì)該地址訪問的 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)異常情況下給用戶以明確的