第一章 引言
一.1 編寫目的
說明編寫詳細設計方案的主要目的。
說明書編制的目的是說明一個軟體系統各個層次中的每個程式(每個子產品或子程式)和資料庫系統的設計考慮,為程式員編碼提供依據。
如果一個軟體系統比較簡單,層次很少,本檔案可以不單獨編寫,和概要設計說明書中不重複部分合并編寫。
方案重點是子產品的執行流程和資料庫系統詳細設計的描述。
一.2 背景
應包含以下幾個方面的内容:
A. 待開發軟體系統名稱;
B. 該系統基本概念, 如該系統的類型、從屬地位等;
C. 開發項目組名稱。
一.3 參考資料
列出詳細設計報告引用的文獻或資料,資料的作者、标題、出版機關和出版日期等資訊,必要時說明如何得到這些資料。
一.4 術語定義及說明
列出本文檔中用到的可能會引起混淆的專門術語、定義和縮寫詞的原文。
第二章 設計概述
二.1 任務和目标
說明詳細設計的任務及詳細設計所要達到的目标 。
二.2 需求概述
對所開發軟體的概要描述, 包括主要的業務需求、輸入、 輸出、主要功能、性能等,尤其需要描述系統性能需求。
二.3 運作環境概述
對本系統所依賴于運作的硬體,包括作業系統、資料庫系統、中間件、接口軟體、可能的性能監控與分析等軟體環境的描述,及配置要求。
二.4 條件與限制
較長的描述系統所受的内部和外部條件的限制和限制說明。包括業務和技術方面的條件與限制以及進度、管理等方面的限制。
二.5 詳細設計方法和工具
簡要說明詳細設計所采用的方法和使用的工具。如HIPO圖方法、IDEF(I2DEF)方法、E-R圖,資料流程圖、業務流程圖、選用的CASE工具等,盡量采用标準規範和輔助工具。
第三章 系統詳細需求分析
主要對系統級的需求進行分析。首先應對需求分析提出的企業需求進一步确認,并對由于情況變化而帶來的需求變化進行較為詳細的分析。
三.1 詳細需求分析
包括:
Ÿ 詳細功能需求分析
Ÿ 詳細性能需求分析
Ÿ 詳細資源需求分析
Ÿ 詳細系統運作環境及限制條件分析
三.2 詳細系統運作環境及限制條件分析接口需求分析
包括:
Ÿ 系統接口需求分析
Ÿ 現有硬、軟體資源接口需求分析
Ÿ 引進硬、軟體資源接口需求分析
第四章 總體方案确認
着重解決系統總體結構确認及界面劃分問題。
四.1 系統總體結構确認
對系統組成、邏輯結構及層次進行确認,對應用系統、支撐系統及各自實作的功能進行确認,細化內建設計及系統工作流程,特别要注意因軟體的引進造成的系統本身結構和公司其他系統的結構變化。包括:
Ÿ 系統組成、邏輯結構及層次确認
Ÿ 應用系統結構确認
Ÿ 支撐系統結構确認
Ÿ 系統內建确認
Ÿ 系統工作流程确認
四.2 系統詳細界面劃分
四.2.1 應用系統與支撐系統的詳細界面劃分
應用系統與支撐系統之間的界面包括系統主伺服器與其他伺服器的服務範圍及通路方式,網絡及資料庫對應用系統的支撐方式,全局資料的管理與存取方式等。
四.2.2 系統内部詳細界面劃分
系統各功能之間的界面包括覆寫範圍,子產品間功能調用涉及到的系統子產品及方法,全局資料格式,系統性能要求等。
第五章 系統詳細設計
五.1 系統結構設計及子系統劃分
對系統的組成及邏輯結構進行設計前确認。
劃分系統功能子產品或子系統(如果有或者有必要,特别是大型的軟體系統)。
五.2 系統功能子產品詳細設計
按結構化設計方法,在系統功能逐層分解的基礎上,對系統各功能子產品或子系統進行設計。此為詳細設計的主要部分之一。
用層次圖描述系統的總體結構、功能分解及各個子產品之間的互相調用關系和資訊互動,用IPO圖或其他方法描述各子產品完成的功能。 以上建議采用HIPO圖進行功能分解與子產品描述,更高的要求建議采用IDEF0方法進行功能模型設計。
詳細設計應用系統的各個構成子產品完成的功能及其互相之間的關系,用IPO或結構圖描述各子產品的組成結構、算法、子產品間的接口關系,以及需求、功能和子產品三者之間的交叉參照關系。
每個子產品的描述說明可參照以下格式:
子產品編号:
子產品名稱:
輸入:
處理:
算法描述:
輸出:
其中處理和算法描述部分主要采用僞碼或具體的程式語言完成。
對詳細設計更高的要求建議用IDEF0圖進行各功能子產品的設計。
如果對軟體需進行二次開發(包括功能擴充、功能改造、使用者界面改造等),則相應的設計工作應該設立子課題完成。
五.3 系統界面詳細設計
系統界面說明應用系統軟體的各種接口。整個系統的其他接口(如系統硬體接口、通訊接口等)在相應的部分說明。
五.3.1 外部界面設計
根據系統界面劃分進行系統外部界面設計,對系統的所有外部接口(包括功能和資料接口)進行設計。
五.3.2 内部界面設計
設計系統内部各功能子產品間的調用關系和資料接口。
五.3.3 使用者界面設計
規定人機界面的内容、界面風格、調用方式等,包括所謂的表單設計、報表設計和使用者需要的列印輸出等設計。此部分内容可能比較多。
第六章
資料庫系統設計
此資料庫設計可單獨成冊,尤其對大型的資料庫應用系統,即有一個單獨的《資料庫設計說明書》。
六.1 6.1設計要求
六.2 6.2 資訊模型設計
确定系統資訊的類型(實體或視圖),确定系統資訊實體的屬性、關鍵字及實體之間的聯系, 較長的描述資料庫和結構設計,資料元素及屬性定義,資料關系模式,資料限制和限制。
六.3 資料庫設計
六.3.1 設計依據
說明資料被通路的頻度和流量,最大資料存儲量,資料增長量,存儲時間等資料庫設計依據。
六.3.2 資料庫種類及特點
說明系統内應用的資料庫種類、各自的特點、數量及如何實作互聯,資料如何傳遞。
六.3.3 資料庫邏輯結構
說明資料庫概念模式向邏輯模式轉換所采用的方法論及工具,完成資料庫概念模式向邏輯模式的轉換。 詳細列出所使用的資料結構中每個資料項、記錄和檔案的辨別、定義、長度及它們之間的互相關系。此節内容為資料庫設計的主要部分。
六.3.4 實體結構設計
列出所使用的資料結構中每個資料項的存儲要求、通路方法、存取機關和存取實體關系等。建立系統程式員視圖,包括:
Ÿ 資料在記憶體中的安排,包括對索引區、緩沖區的設計;
Ÿ 所使用的外存裝置及外存空間的組織,包括索引區、資料塊的組織與劃分;
Ÿ 通路資料的方式方法。
六.3.5 資料庫安全
說明資料的共享方式,如何保證資料的安全性及保密性。
六.3.6 資料字典
編寫詳細的資料字典。 對資料庫設計中涉及到的各種項目,如資料項、記錄、系、文卷模式、子模式等一般要建立起資料字典,以說明它們的辨別符、同義名及有關資訊。
第七章 非功能性設計
第八章 環境配置
開發。測試、運作環境