軟件詳細(xì)設(shè)計編寫說明書

1、XXX工程/軟件/系統(tǒng)詳細(xì)設(shè)計說明書文檔過程記錄表時間修正內(nèi)容校對人版本號備注第一章引言1.1編寫目的11.21.1.3 參考資料1.1.4 術(shù)語定義及說明2.3.第二章設(shè)計概述2.1 任務(wù)和目標(biāo)3.2.2 需求概述3.2.3 運行環(huán)境概述3.2.4 條件與限制3.2.5 詳細(xì)設(shè)計方法和工具3.第三章系統(tǒng)詳細(xì)需求分析4.4.3.1 詳細(xì)需求分析3.2 詳細(xì)系統(tǒng)運行環(huán)境及限制條件分析接口需求分析4第四章總體方案確認(rèn)5.4.1 系統(tǒng)總體結(jié)構(gòu)確認(rèn)5.4.2 系統(tǒng)詳細(xì)界面劃分5.4.2.1 應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細(xì)界面劃分54.2.2 系統(tǒng)內(nèi)部詳細(xì)界面劃分6第五章系統(tǒng)詳細(xì)設(shè)計7.5.1 系統(tǒng)結(jié)構(gòu)設(shè)計及

2、子系統(tǒng)劃分7.5.2 系統(tǒng)功能模塊詳細(xì)設(shè)計7.5.3 系統(tǒng)界面詳細(xì)設(shè)計8.5.3.1 外部界面設(shè)計85.3.2 內(nèi)部界面設(shè)計85.3.3 用戶界面設(shè)計8第六章數(shù)據(jù)庫系統(tǒng)設(shè)計9.6.1 6.1設(shè)計要求9.6.2 6.2信息模型設(shè)計9.6.3 數(shù)據(jù)庫設(shè)計9.6.3.1 設(shè)計依據(jù)96.3.2 數(shù)據(jù)庫種類及特點96.3.3 數(shù)據(jù)庫邏輯結(jié)構(gòu)96.3.4 物理結(jié)構(gòu)設(shè)計106.3.5 數(shù)據(jù)庫平安106.3.6 數(shù)據(jù)字典10第七章非功能性設(shè)計11第八章環(huán)境配置12第一章引言1.1 編寫目的說明編寫詳細(xì)設(shè)計方案的主要目的.說明書編制的目的是說明一個軟件系統(tǒng)各個層次中的每個程序每個模塊或子程序和數(shù)據(jù)庫系統(tǒng)的設(shè)計考

3、慮,為程序員編碼提供依據(jù).如果一個軟件系統(tǒng)比擬簡單,層次很少,本文件可以不單獨編寫,和概要設(shè)計說明書中不重復(fù)局部合弁編寫.方案重點是模塊的執(zhí)行流程和數(shù)據(jù)庫系統(tǒng)詳細(xì)設(shè)計的描述.1.2 背景應(yīng)包含以下幾個方面的內(nèi)容：A.待開發(fā)軟件系統(tǒng)名稱；B.該系統(tǒng)根本概念,如該系統(tǒng)的類型、附屬地位等；C.開發(fā)工程組名稱.1.3 參考資料列出詳細(xì)設(shè)計報告引用的文獻或資料,資料的作者、標(biāo)題、出版單位和出版日期等信息,必要時說明如何得到這些資料.1.4 術(shù)語定義及說明列出本文檔中用到的可能會引起混淆的專門術(shù)語、定義和縮寫詞的原文.第二章設(shè)計概述2.1 任務(wù)和目標(biāo)說明詳細(xì)設(shè)計的任務(wù)及詳細(xì)設(shè)計所要到達的目標(biāo).2.2 需求

4、概述對所開發(fā)軟件的概要描述,包括主要的業(yè)務(wù)需求、輸入、輸出、主要功能、性能等,尤其需要描述系統(tǒng)性能需求.2.3 運行環(huán)境概述對本系統(tǒng)所依賴于運行的硬件,包括操作系統(tǒng)、數(shù)據(jù)庫系統(tǒng)、中間件、接口軟件、可能的性能監(jiān)控與分析等軟件環(huán)境的描述,及配置要求.2.4 條件與限制詳細(xì)描述系統(tǒng)所受的內(nèi)部和外部條件的約束和限制說明.包括業(yè)務(wù)和技術(shù)方面的條件與限制以及進度、治理等方面的限制.2.5 詳細(xì)設(shè)計方法和工具簡要說明詳細(xì)設(shè)計所采用的方法和使用的工具.如HIPO圖方法、IDEF(I2DEF)方法、ER圖,數(shù)據(jù)流程圖、業(yè)務(wù)流程圖、選用的CASE工具等,盡量采用標(biāo)準(zhǔn)標(biāo)準(zhǔn)和輔助工具.第三章系統(tǒng)詳細(xì)需求分析主要對系統(tǒng)

5、級的需求進行分析.首先應(yīng)對需求分析提出的企業(yè)需求進一步確認(rèn),弁對由于情況變化而帶來的需求變化進行較為詳細(xì)的分析.3.1 詳細(xì)需求分析包括：詳細(xì)功能需求分析詳細(xì)性能需求分析詳細(xì)資源需求分析詳細(xì)系統(tǒng)運行環(huán)境及限制條件分析3.2 詳細(xì)系統(tǒng)運行環(huán)境及限制條件分析接口需求分析包括：系統(tǒng)接口需求分析現(xiàn)有硬、軟件資源接口需求分析引進硬、軟件資源接口需求分析第四章總體方案確認(rèn)著重解決系統(tǒng)總體結(jié)構(gòu)確認(rèn)及界面劃分問題.4.1 系統(tǒng)總體結(jié)構(gòu)確認(rèn)對系統(tǒng)組成、邏輯結(jié)構(gòu)及層次進行確認(rèn),對應(yīng)用系統(tǒng)、支撐系統(tǒng)及各自實現(xiàn)的功能進行確認(rèn),細(xì)化集成設(shè)計及系統(tǒng)工作流程,特別要注意因軟件的引進造成的系統(tǒng)本身結(jié)構(gòu)和公司其他系統(tǒng)的結(jié)構(gòu)變化

6、.包括：系統(tǒng)組成、邏輯結(jié)構(gòu)及層次確認(rèn)應(yīng)用系統(tǒng)結(jié)構(gòu)確認(rèn)支撐系統(tǒng)結(jié)構(gòu)確認(rèn)系統(tǒng)集成確認(rèn)系統(tǒng)工作流程確認(rèn)4.2 系統(tǒng)詳細(xì)界面劃分4.2.1 應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細(xì)界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)之間的界面包括系統(tǒng)主效勞器與其他效勞器的效勞范圍及訪問方式,網(wǎng)絡(luò)及數(shù)據(jù)庫對應(yīng)用系統(tǒng)的支撐方式,全局?jǐn)?shù)據(jù)的治理與存取方式等.4.2.2 系統(tǒng)內(nèi)部詳細(xì)界面劃分系統(tǒng)各功能之間的界面包括覆蓋范圍,模塊間功能調(diào)用涉及到的系統(tǒng)模塊及方法,全局?jǐn)?shù)據(jù)格式,系統(tǒng)性能要求等.第五章系統(tǒng)詳細(xì)設(shè)計5.1 系統(tǒng)結(jié)構(gòu)設(shè)計及子系統(tǒng)劃分對系統(tǒng)的組成及邏輯結(jié)構(gòu)進行設(shè)計前確認(rèn).劃分系統(tǒng)功能模塊或子系統(tǒng)如果有或者有必要,特別是大型的軟件系統(tǒng).5.2 系

7、統(tǒng)功能模塊詳細(xì)設(shè)計按結(jié)構(gòu)化設(shè)計方法,在系統(tǒng)功能逐層分解的根底上,對系統(tǒng)各功能模塊或子系統(tǒng)進行設(shè)計.此為詳細(xì)設(shè)計的主要局部之一.用層次圖描述系統(tǒng)的總體結(jié)構(gòu)、功能分解及各個模塊之間的相互調(diào)用關(guān)系和信息交互,用IPO圖或其他方法描述各模塊完成的功能.以上建議采用HIPO圖進行功能分解與模塊描述,更高的要求建議采用IDEF0方法進行功能模型設(shè)計.詳細(xì)設(shè)計應(yīng)用系統(tǒng)的各個構(gòu)成模塊完成的功能及其相互之間的關(guān)系,用IPO或結(jié)構(gòu)圖描述各模塊的組成結(jié)構(gòu)、算法、模塊間的接口關(guān)系,以及需求、功能和模塊三者之間的交叉參照關(guān)系.每個模塊的描述說明可參照以下格式：模塊編號：模塊名稱：輸入：處理：算法描述：輸出：其中處理和算

8、法描述局部主要采用偽碼或具體的程序語言完成.對詳細(xì)設(shè)計更高的要求建議用IDEF0圖進行各功能模塊的設(shè)計.如果對軟件需進行二次開發(fā)包括功能擴展、功能改造、用戶界面改造等,那么相應(yīng)的設(shè)計工作應(yīng)該設(shè)立子課題完成.5.3 系統(tǒng)界面詳細(xì)設(shè)計系統(tǒng)界面說明應(yīng)用系統(tǒng)軟件的各種接口.整個系統(tǒng)的其他接口如系統(tǒng)硬件接口、通訊接口等在相應(yīng)的局部說明.5.3.1 外部界面設(shè)計根據(jù)系統(tǒng)界面劃分進行系統(tǒng)外部界面設(shè)計,對系統(tǒng)的所有外部接口包括功能和數(shù)據(jù)接口進行設(shè)計.5.3.2 內(nèi)部界面設(shè)計設(shè)計系統(tǒng)內(nèi)部各功能模塊間的調(diào)用關(guān)系和數(shù)據(jù)接口.5.3.3 用戶界面設(shè)計規(guī)定人機界面的內(nèi)容、界面風(fēng)格、調(diào)用方式等,包括所謂的表單設(shè)計、報表設(shè)

9、計和用戶需要的打印輸出等設(shè)計.此局部內(nèi)容可能比擬多.第六章數(shù)據(jù)庫系統(tǒng)設(shè)計此數(shù)據(jù)庫設(shè)計可單獨成冊,尤其對大型的數(shù)據(jù)庫應(yīng)用系統(tǒng),即有一個單獨的?數(shù)據(jù)庫設(shè)計說明書?.6.1 6.1設(shè)計要求6.2 6.2信息模型設(shè)計確定系統(tǒng)信息的類型實體或視圖,確定系統(tǒng)信息實體的屬性、關(guān)鍵字及實體之間的聯(lián)系,詳細(xì)描述數(shù)據(jù)庫和結(jié)構(gòu)設(shè)計,數(shù)據(jù)元素及屬性定義,數(shù)據(jù)關(guān)系模式,數(shù)據(jù)約束和限制.6.3 數(shù)據(jù)庫設(shè)計6.3.1 設(shè)計依據(jù)說明數(shù)據(jù)被訪問的頻度和流量,最大數(shù)據(jù)存儲量,數(shù)據(jù)增長量,存儲時間等數(shù)據(jù)庫設(shè)計依據(jù).6.3.2 數(shù)據(jù)庫種類及特點說明系統(tǒng)內(nèi)應(yīng)用的數(shù)據(jù)庫種類、各自的特點、數(shù)量及如何實現(xiàn)互聯(lián),數(shù)據(jù)如何傳遞.6.3.3 數(shù)據(jù)庫邏輯結(jié)構(gòu)說明數(shù)據(jù)庫概念模式向邏輯模式轉(zhuǎn)換所采用的方法論及工具,完成數(shù)據(jù)庫概念模式向邏輯模式的轉(zhuǎn)換.詳細(xì)列出所使用的數(shù)據(jù)結(jié)構(gòu)中每個數(shù)據(jù)項、記錄和文件的標(biāo)識、定義、長度及它們之間的相互關(guān)系.此節(jié)內(nèi)容為數(shù)據(jù)庫設(shè)計的主要局部.6.3.4 物理結(jié)構(gòu)設(shè)計列出所使用的數(shù)據(jù)結(jié)構(gòu)中每個數(shù)據(jù)項的存儲要求、訪問方法、存取單位和存取物理關(guān)系等.建立系統(tǒng)程序員視圖,包括：數(shù)據(jù)在內(nèi)存中的安排,包括對索引區(qū)、緩沖區(qū)的設(shè)計；所使用的外存設(shè)備及外存空間的組織,包括索引區(qū)、數(shù)據(jù)塊的組織與劃分；訪問數(shù)