- 相關推薦
軟件設計文檔模板
文檔編號 研發生產中心 項目名稱 項目來源 QR-RD-022(Ver1.2)版本A1密級商密 AXx 系統Xxx 系統 詳細設計說明書(內部資料 請勿外傳) 編 檢 審 批 寫： 查： 核： 準： 日 期： 日 期： 日 期： 日 期：XX 公 司版權所有 不得復制文檔變更記錄序號 1 2 變更（+/-）說明 作者 版本號 日期 批準目錄1. 引言....................................................................................................................................................... 4 1.1 編寫目的和范圍......................................................................................................................... 4 1.2 術語表......................................................................................................................................... 4 1.3 參考資料..................................................................................................................................... 4 1.4 使用的文字處理和繪圖工具 ..................................................................................................... 4 2. 全局數據結構說明............................................................................................................................... 5 2.1 常量............................................................................................................................................. 5 2.2 變量............................................................................................................................................. 5 2.3 數據結構..................................................................................................................................... 5 3. 模塊設計............................................................................................................................................... 5 3.1 用例圖......................................................................................................................................... 5 3.2 功能設計說明............................................................................................................................. 5 3.2.1 模塊 1............................................................................................................................... 5 3.2.2 模塊 2............................................................................................................................... 6 4. 接口設計............................................................................................................................................... 7 4.1 內部接口..................................................................................................................................... 7 4.2 外部接口..................................................................................................................................... 7 4.2.1 接口說明.......................................................................................................................... 7 4.2.2 調用方式.......................................................................................................................... 8 5. 數據庫設計........................................................................................................................................... 8 6. 系統安全保密設計............................................................................................................................... 8 6.1 說明............................................................................................................................................. 8 6.2 設計............................................................................................................................................. 8 6.2.1 數據傳輸部分 .................................................................................................................. 8 6.2.2 IP 過濾分部 ...................................................................................................................... 8 6.2.3 身份驗證部分 .................................................................................................................. 8 7. 系統性能設計....................................................................................................................................... 9 8. 系統出錯處理....................................................................................................................................... 91. 引言1.1 編寫目的和范圍說明寫這份詳細設計說明書的目的。 本詳細設計說明書編寫的目的是說明程序模塊的設計考慮， 包括程序描述、 輸入/輸出、 算法和流程邏輯等， 為軟件編程和系統維護提供基礎。 本說明書的預期讀者為系統設計人員、 軟件開發人員、軟件測試人員和項目評審人員。1.2 術語表定義系統或產品中涉及的重要術語，為讀者在閱讀文檔時提供必要的參考信息。 序號 1 2 術語或縮略語 PM 說明性定義 Project Manager,項目經理1.3 參考資料列出有關資料的名稱、作者、文件編號或版本等。參考資料包括： a．需求說明書、架構設計說明書等； b．本項目的其他已發表的文件； c．引用文件、資料、軟件開發標準等。 資料名稱 作者 文件編號、版本 資料存放地點1.4 使用的文字處理和繪圖工具文字處理軟件：[編寫設計文檔使用的文字處理軟件，如 RedOffice ] 繪圖工具：[使用的 UML 工具，如 Rose、Jude、Visio]2. 全局數據結構說明本章說明本程序系統中使用的全局數據常量、變量和數據結構。2.1 常量包括數據文件名稱及其所在目錄，功能說明，具體常量說明等。2.2 變量本章說明本程序系統中使用的全局數據常量、變量和數據結構。2.3 數據結構包括數據結構名稱，功能說明，具體數據結構說明（定義、注釋、取值）等。3. 模塊設計3.1 用例圖3.2 功能設計說明 3.2.1 模塊 1模塊 1 主要分為以下幾個子模塊：子模塊 1、子模塊 2 和子模塊 N。3.2.1.1 子模塊 1 3.2.1.1.1 設計圖3.2.1.1.2 功能描述簡要描述子模塊 1 的業務功能。3.2.1.1.3 輸入數據詳細描述用戶輸入的數據(包括任何輸入設備)以及這些數據的有效性檢驗規則。 詳細描述從物理模型中的哪些表獲取數據以及獲取這些數據的條件。3.2.1.1.4 輸出數據詳細描述子功能 1 所產生的數據以及這些數據的表現形式。3.2.1.1.5 業務算法和流程從業務角度詳細描述根據輸入數據產生輸出數據的業務算法和流程。3.2.1.1.6 數據設計給出本程序中的局部數據結構說明，包括數據結構名稱，功能說明，具體數據結構說明 （定義、注釋設計、取值）等。相關數據庫表，數據存儲設計（具體說明需要以文件方式保 存的數據文件名、數據存儲格式、數據項及屬性等。 ）3.2.1.1.7 源程序文件說明給出本程序的各源程序文件的說明，包括源程序文件名稱及其所在目錄，功能說明，包 含的前導文件及函數名稱等。3.2.1.1.8 函數說明具體說明本程序中的各個函數，包括函數名稱及其所在文件，功能，格式，參數，全局 變量，局部變量，返回值，算法說明，使用約束等。3.2.1.1.9 限制條件 3.2.1.1.10 其他說明3.2.2 模塊 2模塊 1 主要分為以下幾個子模塊：子模塊 1、子模塊 2 和子模塊 N。3.2.2.1 子模塊 1 3.2.2.1.1 設計圖3.2.2.1.2 功能描述簡要描述子模塊 1 的業務功能。3.2.2.1.3 輸入數據詳細描述用戶輸入的數據(包括任何輸入設備)以及這些數據的有效性檢驗規則。 詳細描述從物理模型中的哪些表獲取數據以及獲取這些數據的條件。3.2.2.1.4 輸出數據詳細描述子功能 1 所產生的數據以及這些數據的表現形式。3.2.2.1.5 業務算法和流程從業務角度詳細描述根據輸入數據產生輸出數據的業務算法和流程。3.2.2.1.6 數據設計給出本程序中的局部數據結構說明，包括數據結構名稱，功能說明，具體數據結構說明 （定義、注釋設計、取值）等。相關數據庫表，數據存儲設計（具體說明需要以文件方式保 存的數據文件名、數據存儲格式、數據項及屬性等。 ）3.2.2.1.7 源程序文件說明給出本程序的各源程序文件的說明，包括源程序文件名稱及其所在目錄，功能說明，包 含的前導文件及函數名稱等。3.2.2.1.8 函數說明具體說明本程序中的各個函數，包括函數名稱及其所在文件，功能，格式，參數，全局 變量，局部變量，返回值，算法說明，使用約束等。3.2.2.1.9 限制條件 3.2.2.1.10 其他說明4. 接口設計4.1 內部接口 4.2 外部接口 4.2.1 接口說明例如：xx 子系統通過 xx 從 xx 子系統取得 xx 等，相關標準，調用示例，可根據需要增 加章節描述接口。4.2.2 調用方式例如：內部接口調用： 例: /** *通過用戶服務號碼取得該客戶認證密碼等信息，如果該客戶存在返回為 0，其他情況 參考錯誤編碼 */ public RUserInfo getUserInfo (String userNo);5. 數據庫設計詳見[xxx 數據庫設計說明書] 如果數據庫設計內容比較少，則直接在此處描述。6. 系統安全保密設計6.1 說明例如：由于存在與外部系統的接口,所以需要考慮訪問安全的問題.6.2 設計例如：分為數據傳輸部分,IP 過濾部分,身份驗證部分.[章節可補充]6.2.1 數據傳輸部分例如：在部分數據傳遞的時候,考慮以 https 協議,需要在部署的時候作相關處理.6.2.2 IP 過濾分部例如：可在系統前端通過 Filter 實現,該 Filter 實現對該地址訪問的 IP 過濾作用.可 信任 IP 地址通過 xml 文件進行配置.6.2.3 身份驗證部分例如：對信任的用戶,頒發身份驗證碼,通過該標識進行身份識別.7. 系統性能設計8. 系統出錯處理例如：為了在系統出現異常情況下給用戶以明確的提示，可采用兩種方式予以提示： 1．使用 Javascript 的 alert()函數直接提示，這主要在輸入或修改的情況下使用； 2．使用統一的錯誤界面提示，該界面對應于 errorpage.jsp 頁面。錯誤界面樣式如下 圖所示：錯誤提示:“錯誤提示內容”返回錯誤提示界面
【軟件設計文檔】相關文章：
教案-軟件設計04-25
講課比賽總結文檔06-07
文檔管理制度03-23
語文檔的歇后語01-24
項目文檔管理辦法06-08
文檔：我教青蛙寫詩04-29
文檔管理制度07-12
綜合壓力畸變指數的計算軟件設計及驗證05-02
項目部責任書文檔09-23