《軟件詳細(xì)設(shè)計(jì)》由會員分享，可在線閱讀，更多相關(guān)《軟件詳細(xì)設(shè)計(jì)（8頁珍藏版）》請?jiān)谘b配圖網(wǎng)上搜索。

1、研發(fā)生產(chǎn)中心 文檔編號 版本 A1 密級 商密A 項(xiàng)目名稱 Xx系統(tǒng) 項(xiàng)目來源 QR-RD-022(Ver1.2) Xxx 系統(tǒng) 詳細(xì)設(shè)計(jì)說明書 （內(nèi)部資料 請勿外傳） 期： 期： 期： 期： 編 檢 審 批 XX公司 版權(quán)所有 不得復(fù)制 文檔變更記錄 序號 變更（+/-）說明 作者 版本號 日期 批準(zhǔn) 1 2 目錄 1. 引言

2、 3 1.1編寫目的和范圍 3 1.2術(shù)語表 3 1.3參考資料 3 1.4使用的文字處理和繪圖工具 3 2. 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說明 3 2.1常量 3 2.2變量 4 2.3數(shù)據(jù)結(jié)構(gòu) 4 3. 模塊設(shè)計(jì) 4 3.1用例圖 4 3.2功能設(shè)計(jì)說明 4 3.2.1 模塊 1 4 3.2.2 模塊 2 5 4. 接口設(shè)計(jì) 6 4.1內(nèi)部接口 6 4.2外部接口 6 接口說明 6 調(diào)用方式 6 5. 數(shù)據(jù)庫設(shè)計(jì) 6 6. 系統(tǒng)安全保密設(shè)計(jì) 6 6.1說明 6 6.2設(shè)計(jì) 7 數(shù)據(jù)傳輸部分 7 6.2.2 IP過濾分部 7 身份驗(yàn)證部分 7 7. 系統(tǒng)

3、性能設(shè)計(jì) 7 &系統(tǒng)出錯(cuò)處理 7 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ù)語或縮略語 說明性定義 1 PM Project Manager,項(xiàng)目經(jīng)理 2 1.3 參考資料 列出有關(guān)資料的名稱、作者、文件編號或版本

4、等。參考資料包括 a.需求說明書、架構(gòu)設(shè)計(jì)說明書等； b本項(xiàng)目的其他已發(fā)表的文件； c引用文件、資料、軟件開發(fā)標(biāo)準(zhǔn)等。 資料名稱 作者 文件編號、版本 資料存放地點(diǎn) 1.4 使用的文字處理和繪圖工具 文字處理軟件：[編寫設(shè)計(jì)文檔使用的文字處理軟件，如edOffice ] 繪圖工具：[使用的UML工具，如Rose、Jude、Visio] 2. 全局?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ù)常量、變量

5、和數(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ì) 3.1 用例圖 3.2 功能設(shè)計(jì)說明 3.2.1 模塊1 模塊1主要分為以下幾個(gè)子模塊：子模塊、子模塊2和子模塊N。 子模塊 1 3.2.1.1.1 設(shè)計(jì)圖 3.2.1.1.2 功能描述 簡要描述子模塊1 的業(yè)務(wù)功能。 3.2.1.1.3 輸入數(shù)據(jù) 詳細(xì)描述用戶輸入的數(shù)據(jù)（包括任何輸入設(shè)備）以及這些數(shù)據(jù)的有效性檢驗(yàn)規(guī)則。 詳細(xì)描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。 3.2.1.1.4 輸出數(shù)據(jù) 詳細(xì)描述子功能1 所產(chǎn)生的數(shù)據(jù)以及這

6、些數(shù)據(jù)的表現(xiàn)形式。 3.2.1.1.5 業(yè)務(wù)算法和流程 從業(yè)務(wù)角度詳細(xì)描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流程。 3.2.1.1.6 數(shù)據(jù)設(shè)計(jì) 給出本程序中的局部數(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)及屬性等）。 3.2.1.1.7 源程序文件說明 給出本程序的各源程序文件的說明包，括源程序文件名稱及其所在目錄功，能說明，包 含的前導(dǎo)文件及函數(shù)名稱等。 3.2.1.1.8 函數(shù)說明 具體說明本程序中的各個(gè)函數(shù)，包括函數(shù)名稱及其所在文件

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

8、5 業(yè)務(wù)算法和流程 從業(yè)務(wù)角度詳細(xì)描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流程。 3.2.2.1.6 數(shù)據(jù)設(shè)計(jì) 給出本程序中的局部數(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)及屬性等）。 3.2.2.1.7 源程序文件說明 給出本程序的各源程序文件的說明包，括源程序文件名稱及其所在目錄功，能說明，包 含的前導(dǎo)文件及函數(shù)名稱等。 3.2.2.1.8 函數(shù)說明 具體說明本程序中的各個(gè)函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局 變量，局部變量

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

10、如果數(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ǔ)充 6.2.1 數(shù)據(jù)傳輸部分 例如：在部分?jǐn)?shù)據(jù)傳遞的時(shí)候考慮以https協(xié)議,需要在部署的時(shí)候作相關(guān)處理 6.2.2 IP 過濾分部 例如：可在系統(tǒng)前端通過?ilter實(shí)現(xiàn)該Filter實(shí)現(xiàn)對該地址訪問的EP過濾作用可 信任IP地址通過xml文件進(jìn)行配置 6.2.3 身份驗(yàn)證部分 例如：對信任的用戶,頒發(fā)身份驗(yàn)證碼,通過該標(biāo)識進(jìn)行身份識別. 7. 系統(tǒng)性能設(shè)計(jì) 8. 系統(tǒng)出錯(cuò)處理 例如：為了在系統(tǒng)出現(xiàn)異常情況下給用戶以明確的提示，可采用兩種方式予以提示 1. 使用Javascript的alert()函數(shù)直接提示，這主要在輸入或修改的情況下使用； 2. 使用統(tǒng)一的錯(cuò)誤界面提示，該界面對應(yīng)于Trorpage.jsp頁面。錯(cuò)誤界面樣式如下 圖所示： 錯(cuò)誤提示界面