|
產品名稱Product name |
密級Confidentiality level |
|
|
|
|
產品版本Product version |
Total 8 pages 共 8 頁 |
|
V1.01 |
XXX軟件詳細設計說明書
|
Prepared by 擬製 |
|
Date 日期 |
2010-11-23 |
|
Reviewed by 評審人 |
|
Date 日期 |
|
|
Approved by 批准 |
|
Date 日期 |
|
Revision Record 修訂記錄
|
Date 日期 |
Revision Version 修訂 |
Sec No. |
Change Description 修改描述 |
Author 作者 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
目錄
1 引言. 5
1.1 編寫目的. 5
1.2 背景. 5
1.3 參考資料. 5
1.4 術語定義及說明. 5
2 設計概述. 5
2.1 任務和目標. 5
2.1.1 需求概述. 5
2.1.2 運行環境概述. 6
2.1.3 條件與限制. 6
2.1.4 詳細設計方法和工具. 6
3 系統詳細需求分析. 6
3.1 詳細需求分析. 6
3.2 詳細系統運行環境及限制條件分析接口需求分析. 6
4 總體方案確認. 7
4.1 系統總體結構確認. 7
4.2 系統詳細界面劃分. 7
4.2.1 應用系統與支撐系統的詳細界面劃分. 7
4.2.2 系統內部詳細界面劃分. 7
5 系統詳細設計. 7
5.1 系統結構設計及子系統劃分. 7
5.2 系統功能模塊詳細設計. 8
5.3 系統界面詳細設計. 8
5.3.1 外部界面設計. 8
5.3.2 內部界面設計. 9
5.3.3 用戶界面設計. 9
6、 數據庫系統設計. 9
6.1設計要求. 9
6.2 信息模型設計. 9
6.3 數據庫設計. 9
6.3.1 設計依據. 9
6.3.2 數據庫選型. 9
6.3.3 數據庫種類及特點. 9
6.3.4 數據庫邏輯結構. 9
6.3.5 物理結構設計. 10
6.3.6 數據庫安全. 10
6.3.7 數據字典. 10
7 信息編碼設計. 10
7.3 代碼結構設計. 10
7.4 代碼編制. 10
1 引言
1.1 編寫目的
說明編寫詳細設計方案的主要目的。
說明書編制的目的是說明一個軟件系統各個層次中的每個程序（每個模塊或子程序）和數據庫系統的設計考慮，爲程序員編碼提供依據。
如果一個軟件系統比較簡單，層次很少，本文件可以不單獨編寫，和概要設計說明書中不重複部分合並編寫。
方案重點是模塊的執行流程和數據庫系統詳細設計的描述。
1.2 背景
應包含以下幾個方面的內容：
A. 待開發軟件系統名稱；
B. 該系統基本概念， 如該系統的類型、從屬地位等；
C. 開發項目組名稱。
1.3 參考資料
列出詳細設計報告引用的文獻或資料，資料的作者、標題、出版單位和出版日期等信息，必要時說明如何得到這些資料。
1.4 術語定義及說明
列出本文檔中用到的可能會引起混淆的專門術語、定義和縮寫詞的原文。
2 設計概述
2.1 任務和目標
說明詳細設計的任務及詳細設計所要達到的目標 。
2.1.1 需求概述
對所開發軟件的概要描述, 包括主要的業務需求、輸入、輸出、主要功能、性能等，尤其需要描述系統性能需求。
2.1.2 運行環境概述
對本系統所依賴於運行的硬件，包括操作系統、數據庫系統、中間件、接口軟件、可能的性能監控與分析等軟件環境的描述，及配置要求。
2.1.3 條件與限制
詳細描述系統所受的內部和外部條件的約束和限制說明。包括業務和技術方面的條件與限制以及進度、管理等方面的限制。
2.1.4 詳細設計方法和工具
簡要說明詳細設計所採用的方法和使用的工具。如HIPO圖方法、IDEF（I2DEF）方法、E－R圖，數據流程圖、業務流程圖、選用的CASE工具等，儘量採用標準規範和輔助工具。
3 系統詳細需求分析
主要對系統級的需求進行分析。首先應對需求分析提出的企業需求進一步確認，並對由於情況變化而帶來的需求變化進行較爲詳細的分析。
3.1 詳細需求分析
包括：
- 詳細功能需求分析
- 詳細性能需求分析
- 詳細資源需求分析
- 詳細系統運行環境及限制條件分析
3.2 詳細系統運行環境及限制條件分析接口需求分析
包括：
- 系統接口需求分析
- 現有硬、軟件資源接口需求分析
- 引進硬、軟件資源接口需求分析
4 總體方案確認
着重解決系統總體結構確認及界面劃分問題。
4.1 系統總體結構確認
對系統組成、邏輯結構及層次進行確認，對應用系統、支撐系統及各自實現的功能進行確認，細化集成設計及系統工作流程，特別要注意因軟件的引進造成的系統本身結構和公司其他系統的結構變化。包括：
系統組成、邏輯結構及層次確認
應用系統結構確認
支撐系統結構確認
系統集成確認
系統工作流程確認
4.2 系統詳細界面劃分
4.2.1 應用系統與支撐系統的詳細界面劃分
應用系統與支撐系統之間的界面包括系統主服務器與其他服務器的服務範圍及訪問方式，網絡及數據庫對應用系統的支撐方式，全局數據的管理與存取方式等。
4.2.2 系統內部詳細界面劃分
系統各功能之間的界面包括覆蓋範圍，模塊間功能調用涉及到的系統模塊及方法，全局數據格式，系統性能要求等。
5 系統詳細設計
5.1 系統結構設計及子系統劃分
對系統的組成及邏輯結構進行設計前確認。
劃分系統功能模塊或子系統（如果有或者有必要，特別是大型的軟件系統）。
5.2 系統功能模塊詳細設計
按結構化設計方法，在系統功能逐層分解的基礎上，對系統各功能模塊或子系統進行設計。此爲詳細設計的主要部分之一。
用層次圖描述系統的總體結構、功能分解及各個模塊之間的相互調用關係和信息交互，用IPO圖或其他方法描述各模塊完成的功能。 以上建議採用HIPO圖進行功能分解與模塊描述，更高的要求建議採用IDEF0方法進行功能模型設計。
詳細設計應用系統的各個構成模塊完成的功能及其相互之間的關係，用IPO或結構圖描述各模塊的組成結構、算法、模塊間的接口關係，以及需求、功能和模塊三者之間的交叉參照關係。
每個模塊的描述說明可參照以下格式：
模塊編號：
模塊名稱：
輸入：
處理：
算法描述：
輸出：
其中處理和算法描述部分主要採用僞碼或具體的程序語言完成。
對詳細設計更高的要求建議用IDEF0圖進行各功能模塊的設計。
如果對軟件需進行二次開發（包括功能擴展、功能改造、用戶界面改造等），則相應的設計工作應該設立子課題完成。
5.3 系統界面詳細設計
系統界面說明應用系統軟件的各種接口。整個系統的其他接口（如系統硬件接口、通訊接口等）在相應的部分說明。
5.3.1 外部界面設計
根據系統界面劃分進行系統外部界面設計，對系統的所有外部接口（包括功能和數據接口）進行設計。
5.3.2 內部界面設計
設計系統內部各功能模塊間的調用關係和數據接口。
5.3.3 用戶界面設計
規定人機界面的內容、界面風格、調用方式等，包括所謂的表單設計、報表設計和用戶需要的打印輸出等設計。此部分內容可能比較多。
6、 數據庫系統設計
此數據庫設計可單獨成冊，尤其對大型的數據庫應用系統，即有一個單獨的《數據庫設計說明書》。
6.1設計要求
6.2 信息模型設計
確定系統信息的類型（實體或視圖），確定系統信息實體的屬性、關鍵字及實體之間的聯繫，詳細描述數據庫和結構設計，數據元素及屬性定義，數據關係模式，數據約束和限制。
6.3 數據庫設計
6.3.1 設計依據
說明數據被訪問的頻度和流量，最大數據存儲量，數據增長量，存儲時間等數據庫設計依據。
6.3.2 數據庫種類及特點
說明系統內應用的數據庫種類、各自的特點、數量及如何實現互聯，數據如何傳遞。
6.3.3 數據庫邏輯結構
說明數據庫概念模式向邏輯模式轉換所採用的方法論及工具，完成數據庫概念模式向邏輯模式的轉換。詳細列出所使用的數據結構中每個數據項、記錄和文件的標識、定義、長度及它們之間的相互關係。此節內容爲數據庫設計的主要部分。
6.3.4 物理結構設計
列出所使用的數據結構中每個數據項的存儲要求、訪問方法、存取單位和存取物理關係等。建立系統程序員視圖，包括：
數據在內存中的安排，包括對索引區、緩衝區的設計；
所使用的外存設備及外存空間的組織，包括索引區、數據塊的組織與劃分；
訪問數據的方式方法。
6.3.5 數據庫安全
說明數據的共享方式，如何保證數據的安全性及保密性。
6.3.6 數據字典
編寫詳細的數據字典。 對數據庫設計中涉及到的各種項目，如數據項、記錄、系、文卷模式、子模式等一般要建立起數據字典，以說明它們的標識符、同義名及有關信息。
7 信息編碼設計
7.3 代碼結構設計
確認信息分類編碼總體方案，進行分類代碼結構設計。
7.4 代碼編制
按代碼結構編制信息代碼