詳細設計文檔

詳細設計模板 

目 錄 

1 引言 .... 5 

1.1 編寫目的 ... 5 

1.2 背景 ... 5 

1.3 參考資料 ... 5 

1.4 術語定義及說明 ... 5 

2 設計概述 .... 5 

2.1 任務和目標 ... 5 

2.1.1 需求概述 ... 6 

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 系統功能模塊詳細設計 ... 7 

5.3 系統界面詳細設計 ... 8 

5.3.1 外部界面設計 ... 8 

5.3.2 內部界面設計 ... 8 

5.3.3 用戶界面設計 ... 8 

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 物理結構設計 ... 9 

6.3.6 數據庫安全 ... 10 

6.3.7 數據字典 ... 10 

7 網絡通訊系統設計 .... 10 

7.1 設計要求 ... 10 

7.2 網絡結構確認 ... 10 

7.3 網絡佈局設計 ... 10 

7.4 網絡接口設計 ... 10 

8 信息編碼設計 .... 10 

8.1 代碼結構設計 ... 10 

8.2 代碼編制 ... 10 

9 維護設計 .... 11 

9.1 系統的可靠性和安全性 ... 11 

9.2 系統及用戶維護設計 ... 11 

9.3 系統擴充 ... 11 

9.4 錯誤處理 ... 11 

9.4.1 出錯類別 ... 11 

9.4.2 出錯處理 ... 11 

9.4.3 系統調整及再次開發問題 ... 11 

10 系統配置 .... 11 

10.1 配置原則 ... 11 

10.2 硬件配置 ... 12 

10.3 軟件配置 ... 12 

11 關鍵技術 .... 12 

11.1 關鍵技術的提出 ... 12 

11.2 關鍵技術的通常說明 ... 12 

11.3 關鍵技術的實現方案 ... 12 

12 組織機構及人員配置 .... 12 

13 投資預算概算及資金規劃 .... 12 

14 實施計劃 .... 13 

14.1 限制 ... 13 

14.2 實施內容和進度安排 ... 13 

14.3 實施條件和措施 ... 13 

14.4 系統測試計劃 ... 13 

14.4.1 測試策略 ... 13 

14.4.2 測試方案 ... 13 

14.4.3 預期的測試結果 ... 13 

14.4.4 測試進度計劃 ... 13 

14.5 驗收標準 ... 13 

  

  

1 引言 

1.1 編寫目的 

明編寫詳細設計方案的主要目的。 

詳細設計的主要任務是對概要設計方案作完善和細化。說明書編制的目的是說明一個軟件系統各個層次中的每一個程序（每一個模塊或子程序）和數據庫系統的設計考慮，爲程序員編碼提供依據。 

若是一個軟件系統比較簡單，層次不多，本文件能夠不單獨編寫，和概要設計說明書中不重複部分合並編寫。 

方案重點是模塊的執行流程和數據庫系統詳細設計的描述 。 

1.2 背景 

應包含如下幾個方面的內容： 

A. 待開發軟件系統名稱； 

B. 該系統基本概念，如該系統的類型、從屬地位等； 

C. 開發項目組名稱； 

D. 項目代號（項目規劃所採用的代號）； 

E. 說明聽從的IT 標準和原則，符合公司的IT ABBs 。 

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 詳細需求分析 

包括： 

A.      詳細功能需求分析 

B.      詳細性能需求分析 

C.      詳細信息需求分析 

D.      詳細資源需求分析 

E.      詳細組織需求分析 

F.      詳細系統運行環境及限制條件分析 

3.2 詳細系統運行環境及限制條件分析接口需求分析 

包括： 

A.      系統接口需求分析 

B.      現有硬、軟件資源接口需求分析 

C.      引進硬、軟件資源接口需求分析 

4 整體方案確認 

着重解決系統整體結構確認及界面劃分問題。  

4.1 系統整體結構確認 

對系統組成、邏輯結構及層次進行確認，對應用系統、支撐系統及各自實現的功能進行確認，細化集成設計及系統工做流程，特別要注意因軟件的引進形成的系統自己結構和公司其餘系統的結構變化。包括： 

A.      系統組成、邏輯結構及層次確認 

B.      應用系統結構確認 

C.      支撐系統結構確認 

D.      系統集成確認 

E.      系統工做流程確認 

4.2 系統詳細界面劃分 

對系統內部各功能及系統與外界之間的界面進一步細化。 

4.2.1 應用系統與支撐系統的詳細界面劃分 

應用系統與支撐系統之間的界面包括系統主服務器與其餘服務器的服務範圍及訪問方式，網絡及數據庫對應用系統的支撐方式，全局數據的管理與存取方式等。 

4.2.2 系統內部詳細界面劃分 

系統各功能之間的界面包括覆蓋範圍，模塊間功能調用涉及到的系統模塊及方法，全局數據格式，系統性能要求等。 

5 系統詳細設計 

5.1 系統結構設計及子系統劃分 

對系統的組成及邏輯結構進行設計前確認。 

劃分系統功能模塊或子系統（若是有或者有必要，特別是大型的軟件系統）。 

5.2 系統功能模塊詳細設計 

按結構化設計方法，在系統功能逐層分解的基礎上，對系統各功能模塊或子系統進行設計。此爲詳細設計的主要部分之一。 

用層次圖（H 圖）描述系統的整體結構、功能分解及各個模塊之間的相互調用關係和信息交互，用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 物理結構設計 列出所使用的數據結構中每一個數據項的存儲要求、訪問方法、存取單位和存取物理關係等。創建系統程序員視圖，包括： 

A.      數據在內存中的安排，包括對索引區、緩衝區的設計； 

B.      所使用的外存設備及外存空間的組織，包括索引區、數據塊的組織與劃分； 

C.      訪問數據的方式方法。 

  

6.3.6 數據庫安全 

說明數據的共享方式，如何保證數據的安全性及保密性。 

6.3.7 數據字典 

編寫詳細的數據字典。 對數據庫設計中涉及到的各類項目，如數據項、記錄、系、文卷模式、子模式等通常要創建起數據字典，以說明它們的標識符、同義名及有關信息。 

7 網絡通訊系統設計 

（對比較大型的分佈式系統項目，特別是擁有獨立網絡架構的項目，此部分比較重要）。 

7.1 設計要求 

系統對網絡通訊設計的要求。 

網絡設計對公司網絡大環境的要求和影響。 

7.2 網絡結構確認 

確認網絡選型及網絡拓撲結構，網絡協議及服務、通訊軟件，網絡互聯方法，信息載體及硬件配置。 

7.3 網絡佈局設計 

細化網絡的物理佈局，明確站點分佈的位置及相互間的距離，提出網絡安裝施工的要求。 

7.4 網絡接口設計 

系統的硬件和通信接口設計，如服務器的網絡接口、協議等。 

8 信息編碼設計 

信息編碼應在詳細設計階段完成。 

8.1 代碼結構設計 

確認信息分類編碼整體方案，進行分類代碼結構設計。 

8.2 代碼編制 

按代碼結構編制信息代碼 

  

9 維護設計 維護設計針對系統運做的一些問題展開，具體條目參照概要設計方案。若是此部分在概要設計方案中已經足夠詳細而且可操做，在詳細設計裏也可省略。 

9.1 系統的可靠性和安全性 

系統在運行可靠性和安全性方面對用戶需求的滿意程度和特殊設計、考慮( 若是有的話) 。 

9.2 系統及用戶維護設計 對通常用戶平常維護操做和系統管理的平常維護進行設計，如備份、恢復操做，數據物理安全。 

9.3 系統擴充 

系統的功能擴充、容量擴大和可移植性、開放性等方面的說明 。 

9.4 錯誤處理 9.4.1 出錯類別 

如系統對可能出現的某些錯誤和故障做了專門的設計考慮, 給出這些錯誤或故障的定義和對錯誤進行編碼。 

9.4.2 出錯處理 

說明將使用的恢復或再啓動技術， 使軟件從故障點恢復執行或軟件從頭開始從新運行的方法。 

9.4.3 系統調整及再次開發問題 將來可能對系統進行的一些調整、限制和再次開發等問題，以及詳細設計中還沒有解決但開發者認爲在開發階段必須解決的問題。 

10 系統配置 

系統軟件硬件配置資源明細及配置方案。這部分針對概要設計相應部分加以補充和細化，輸出爲可操做的具體方案。 

10.1 配置原則 

說明系統的配置原則，如根據目標、需求、資源、階段等的配置，特別須要包括系統的詳細性能需求。 

10.2 硬件配置 

列出開發及運行系統所須要的硬件平臺、工具等，說明採用依據。將各層的硬件及網絡配置方案列出圖及表，並加以說明。 

10.3 軟件配置 

列出開發及運行本系統所須要的軟件平臺（操做系統、數據庫、網絡平臺等）、軟件輔助工具及使用週期，說明採用依據。將系統軟件配置( 如網絡管理軟件、數據庫管理軟件、客戶端軟件等) 方案列出圖表，並加以說明。 

11 關鍵技術 

關鍵技術指項目所採用的核心技術或技術難點、新技術( 若是有的話) 。 

在詳細設計階段應確認概要設計中關鍵技術的設置，對每一項關鍵技術進一步明確詳細的解決方案。 

11.1 關鍵技術的提出 

說明關鍵技術提出的原則。 

11.2 關鍵技術的通常說明 

說明關鍵技術的名稱、必要性、技術難點、進度、計劃等( 能夠用表格) 。 

11.3 關鍵技術的實現方案 

詳細介紹各項關鍵技術的實現方案。 

12 組織機構及人員配置 

說明系統運行對企業組織機構設置的要求，組織機構調整方案，調整後組織機構的任務和職責。 

說明系統對人員配置的要求和配置方案。 

13 投資預算概算及資金規劃 

列出經費投資預算表，說明系統的基本建設費用（包括系統平臺軟件硬件和應用軟件），說明一次性投資及分期投資的項和投資數額。計算項目總投資和分類投資明細。 

對投資方面的限制要在此單獨說明。 

14 實施計劃 

說明項目的下一步實施計劃和具體的實施方案，爲確保方案實施在技術方法、組織機構、人員配置、技術培訓等等所應採起的措施和計劃。包括系統測試計劃和驗收標準。 

14.1 限制 

說明在進度設計和實施等方面的限制。 

14.2 實施內容和進度安排 

對本期實施的內容、進度等進行詳細的說明，要求計劃切實、可操做，需求條件清楚，時間比較精確，目標清楚，進度可檢查。對準備遠期實施的內容與進度只要求大體說明。 

14.3 實施條件和措施 

對實施條件和所採起的具體措施進行描述。 

14.4 系統測試計劃 

系統的測試方案及計劃，要求涉及從頂層到底層各模塊。 

概要設計後期的測試計劃重點放在集成測試，而詳細設計後應該提供詳細的單元測試計劃。 

測試計劃和方案部分可單獨編寫成冊。 

14.4.1 測試策略 

說明系統調試的環境、工具，集成測試的方法( 從下而上或從上而下) ，模塊測試的順序，步驟, 並給出輔助的模塊或驅動模塊及測試用例, 說明這些測試用例的選取原則。 

14.4.2 測試方案 

  

14.4.3 預期的測試結果 

  

14.4.4 測試進度計劃 

14.5 驗收標準 

明確工程驗收辦法及步驟，對涉及到的各項驗收標準、計量標準及質量標準進行說明。