軟件詳細設(shè)計

1、研發(fā)生產(chǎn)中心文檔編號版本A1密級商密A項目名稱XX系統(tǒng)項目來源QR-RD-022(Ver1.2)Xxx系統(tǒng)詳細設(shè)計說明書(內(nèi)部資料請勿外傳)期:期:期:期:編 檢 審 批XX公司版權(quán)所有不得復(fù)制文檔變更記錄序號變更（+/-）說明作者版本號日期批準12目錄1. 引言 51.1 編寫目的和范圍 51.2 術(shù)語表 51.3 參考資料 51.4 使用的文字處理和繪圖工具 52. 全局數(shù)據(jù)結(jié)構(gòu)說明 62.1 常量 62.2 變量 62.3 數(shù)據(jù)結(jié)構(gòu) 63. 模塊設(shè)計 63.1 用例圖 63.2 功能設(shè)計說明 63.2.1 模塊 1 63.2.2 模塊 2 74. 接口設(shè)計 84.1 內(nèi)部接口 84.2

2、外部接口 84.2.1 接口說明 84.2.2 調(diào)用方式 85. 數(shù)據(jù)庫設(shè)計 96. 系統(tǒng)安全保密設(shè)計 96.1 說明 96.2 設(shè)計 96.2.1 數(shù)據(jù)傳輸部分 96.2.2 IP 過濾分部 96.2.3 身份驗證部分 97. 系統(tǒng)性能設(shè)計 108. 系統(tǒng)出錯處理 101. 引言1.1編寫目的和范圍說明寫這份詳細設(shè)計說明書的目的。本詳細設(shè)計說明書編寫的目的是說明程序模塊的設(shè)計考慮， 包括程序描述、輸入/輸出、 算法和流程邏輯等，為軟件編程和系統(tǒng)維護提供基礎(chǔ)。本說明書的預(yù)期讀者為系統(tǒng)設(shè)計人員、 軟件開發(fā)人員、軟件測試人員和項目評審人員。1.2術(shù)語表定義系統(tǒng)或產(chǎn)品中涉及的重要術(shù)語，為讀者在閱讀文

3、檔時提供必要的參考信息序號術(shù)語或縮略語說明性定義1PMProject Ma nager,項目經(jīng)理21.3參考資料列出有關(guān)資料的名稱、作者、文件編號或版本等。參考資料包括:a.需求說明書、架構(gòu)設(shè)計說明書等；b本項目的其他已發(fā)表的文件；c.引用文件、資料、軟件開發(fā)標準等。資料名稱作者文件編號、版本資料存放地點1.4使用的文字處理和繪圖工具文字處理軟件：編寫設(shè)計文檔使用的文字處理軟件，如 RedOffice 繪圖工具：使用的UML工具，女口 Rose Jude、Visio2. 全局數(shù)據(jù)結(jié)構(gòu)說明本章說明本程序系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。2.1 常量包括數(shù)據(jù)文件名稱及其所在目錄，功能說明，

4、具體常量說明等。2.2 變量本章說明本程序系統(tǒng)中使用的全局數(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è)計3.1 用例圖3.2 功能設(shè)計說明3.2.1 模塊 1模塊 1主要分為以下幾個子模塊：子模塊 1、子模塊 2 和子模塊 N。 子模塊 .1 設(shè)計圖.2 功能描述簡要描述子模塊 1 的業(yè)務(wù)功能。.3 輸入數(shù)據(jù)詳細描述用戶輸入的數(shù)據(jù) （ 包括任何輸入設(shè)備 ） 以及這些數(shù)據(jù)的有效性檢驗規(guī)則詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件.4

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

6、，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局 變量，局部變量，返回值，算法說明，使用約束等。.9 限制條件.10 其他說明3.2.2 模塊 2模塊 1主要分為以下幾個子模塊：子模塊 1、子模塊 2 和子模塊 N。 子模塊 .1 設(shè)計圖.2 功能描述簡要描述子模塊 1 的業(yè)務(wù)功能。.3 輸入數(shù)據(jù)詳細描述用戶輸入的數(shù)據(jù) （ 包括任何輸入設(shè)備 ） 以及這些數(shù)據(jù)的有效性檢驗規(guī)則。詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。.4 輸出數(shù)據(jù)詳細描述子功能 1 所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的

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

8、，局部變量，返回值，算法說明，使用約束等。.9 限制條件.10 其他說明4. 接口設(shè)計4.1 內(nèi)部接口4.2 外部接口4.2.1 接口說明例如：XX子系統(tǒng)通過XX從XX子系統(tǒng)取得XX等，相關(guān)標準，調(diào)用示例，可根據(jù)需要增 加章節(jié)描述接口。4.2.2 調(diào)用方式例如：內(nèi)部接口調(diào)用：例:* 通過用戶服務(wù)號碼取得該客戶認證密碼等信息，如果該客戶存在返回為0，其他情況參考錯誤編碼*/public RUserInfo getUserInfo (String userNo);5. 數(shù)據(jù)庫設(shè)計詳見 xxx 數(shù)據(jù)庫設(shè)計說明書 如果數(shù)據(jù)庫設(shè)計內(nèi)容比較少，則直接在此處描述。6. 系統(tǒng)安全保

9、密設(shè)計6.1 說明例如：由于存在與外部系統(tǒng)的接口 , 所以需要考慮訪問安全的問題 .6.2 設(shè)計例如：分為數(shù)據(jù)傳輸部分 ,IP 過濾部分,身份驗證部分 . 章節(jié)可補充 6.2.1 數(shù)據(jù)傳輸部分例如：在部分數(shù)據(jù)傳遞的時候 , 考慮以 https 協(xié)議 , 需要在部署的時候作相關(guān)處理 .6.2.2 IP 過濾分部例如：可在系統(tǒng)前端通過 Filter 實現(xiàn),該 Filter 實現(xiàn)對該地址訪問的 IP 過濾作用. 可 信任 IP 地址通過 xml 文件進行配置 .6.2.3 身份驗證部分例如：對信任的用戶 ,頒發(fā)身份驗證碼 ,通過該標識進行身份識別7. 系統(tǒng)性能設(shè)計8. 系統(tǒng)出錯處理例如：為了在系統(tǒng)出現(xiàn)異常情況