軟件詳細設計文檔模板

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

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

3、審人員。 列出有關資料的名稱、作者、文件編號或版本等。參考資料包括:a .需求說明書、架構設計說明書等;b .本項目的其他已發(fā)表的文件;c .引用文件、資料、軟件開發(fā)標準等。 文字處理軟件:編寫設計文檔使用的文字處理軟件,如 RedOffice 繪圖工具:使用的 UML 工具,如 Rose 、 Jude 、 Visio2. 全局數(shù)據(jù)結構說明本章說明本程序系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結構。包括數(shù)據(jù)文件名稱及其所在目錄,功能說明,具體常量說明等。本章說明本程序系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結構。包括數(shù)據(jù)結構名稱,功能說明,具體數(shù)據(jù)結構說明(定義、注釋、取值等。 3. 模塊設計3.2.

4、1模塊 1模塊 1主要分為以下幾個子模塊:子模塊 1、子模塊 2和子模塊 N 。 子模塊 .1 設計圖.2 功能描述簡要描述子模塊 1的業(yè)務功能。.3 輸入數(shù)據(jù)詳細描述用戶輸入的數(shù)據(jù) (包括任何輸入設備 以及這些數(shù)據(jù)的有效性檢驗規(guī)則。 詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。.4 輸出數(shù)據(jù)詳細描述子功能 1所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。.5 業(yè)務算法和流程從業(yè)務角度詳細描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務算法和流程。.6 數(shù)據(jù)設計 給出本程序中的局部數(shù)據(jù)結構說明，包括數(shù)據(jù)

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

6、子模塊 2 和子模塊 N。 子模塊 1 .1 設計圖 .2 功能描述 簡要描述子模塊 1 的業(yè)務功能。 .3 輸入數(shù)據(jù) 詳細描述用戶輸入的數(shù)據(jù)(包括任何輸入設備以及這些數(shù)據(jù)的有效性檢驗規(guī)則。 詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。 .4 輸出數(shù)據(jù) 詳細描述子功能 1 所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。 .5 業(yè)務算法和流程 從業(yè)務角度詳細描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務算法和流程。 .6 數(shù)據(jù)設計 給出本程序中的局部數(shù)據(jù)結構說明，包括數(shù)據(jù)結構名稱，功能說明，具體數(shù)據(jù)結構

7、說明 （定義、注釋設計、取值）等。相關數(shù)據(jù)庫表，數(shù)據(jù)存儲設計（具體說明需要以文件方式保 存的數(shù)據(jù)文件名、數(shù)據(jù)存儲格式、數(shù)據(jù)項及屬性等。 ） .7 源程序文件說明 給出本程序的各源程序文件的說明，包括源程序文件名稱及其所在目錄，功能說明，包 含的前導文件及函數(shù)名稱等。 .8 函數(shù)說明 具體說明本程序中的各個函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局 變量，局部變量，返回值，算法說明，使用約束等。 .9 限制條件 .10 其他說明 4. 接口設計 4.1 內部接口 4.2 外部接口 4.2.1 接口說明 例如：xx 子系統(tǒng)通過 x

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