軟件項目詳細(xì)設(shè)計文檔示例模版

1、（此處填入項目名稱）XXX軟件/項目/系統(tǒng)詳細(xì)設(shè)計說明書 擬制日期評審人日期批準(zhǔn)日期編寫單位或個人修訂歷史日期版本作者章節(jié)備注 目錄XXX軟件詳細(xì)設(shè)計說明書1Revision Record 修訂記錄21引言31.1編寫目的31.2背景41.3參考資料41.4術(shù)語定義及說明42設(shè)計概述42.1任務(wù)和目標(biāo)42.1.1需求概述42.1.2運行環(huán)境概述42.1.3條件與限制42.1.4詳細(xì)設(shè)計方法和工具43系統(tǒng)詳細(xì)需求分析43.1詳細(xì)需求分析53.2詳細(xì)系統(tǒng)運行環(huán)境及限制條件分析接口需求分析54總體方案確認(rèn)54.1系統(tǒng)總體結(jié)構(gòu)確認(rèn)54.2系統(tǒng)詳細(xì)界面劃分54.2.1應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細(xì)界面劃分54

2、.2.2系統(tǒng)內(nèi)部詳細(xì)界面劃分55系統(tǒng)詳細(xì)設(shè)計55.1系統(tǒng)結(jié)構(gòu)設(shè)計及子系統(tǒng)劃分65.2系統(tǒng)功能模塊詳細(xì)設(shè)計65.3系統(tǒng)界面詳細(xì)設(shè)計65.3.1外部界面設(shè)計65.3.2內(nèi)部界面設(shè)計65.3.3用戶界面設(shè)計66、數(shù)據(jù)庫系統(tǒng)設(shè)計76.1設(shè)計要求76.2 信息模型設(shè)計76.3數(shù)據(jù)庫設(shè)計76.3.1設(shè)計依據(jù)76.3.2數(shù)據(jù)庫種類及特點76.3.3數(shù)據(jù)庫邏輯結(jié)構(gòu)76.3.4物理結(jié)構(gòu)設(shè)計76.3.5數(shù)據(jù)庫安全76.3.6數(shù)據(jù)字典77非功能性設(shè)計7889環(huán)境配置81 引言1.1 編寫目的說明編制的目的是，大體上介紹一下軟件系統(tǒng)中各層次中模塊或子程序、以及數(shù)據(jù)庫系統(tǒng)的設(shè)計考慮，表明此文檔是主要是為編碼人員提供服務(wù)

3、，并且其他類型的項目參與人員也可以通過此文檔對軟件/項目有更深入了解。1.2 背景說明此軟件或系統(tǒng)的項目背景、需求背景、開發(fā)目的等，還可以列出參與人員等相關(guān)信息。1.3 參考資料列出本文檔中引用的文獻(xiàn)、資料、標(biāo)準(zhǔn)等相關(guān)信息（一般是具有出版或版權(quán)性質(zhì)的文件）。1.4 術(shù)語定義及說明列出文檔中用到的和開發(fā)有關(guān)，或與行業(yè)、業(yè)務(wù)、需求有關(guān)的專業(yè)術(shù)語，并進行解釋。2 設(shè)計概述2.1 任務(wù)和目標(biāo)說明詳細(xì)設(shè)計的任務(wù)及詳細(xì)設(shè)計所要達(dá)到的目標(biāo) 。2.1.1 需求概述對所開發(fā)軟件的概要描述, 包括主要的業(yè)務(wù)需求、輸入、 輸出、主要功能、性能等，尤其需要描述系統(tǒng)性能需求。2.1.2 運行環(huán)境概述對本系統(tǒng)所依賴于運行

4、的硬件，包括操作系統(tǒng)、數(shù)據(jù)庫系統(tǒng)、運行庫、中間件、接口軟件、可能的性能監(jiān)控與分析等軟件環(huán)境的描述，及配置要求。2.1.3 條件與限制詳細(xì)描述系統(tǒng)所受的內(nèi)部和外部條件的約束和限制說明。包括業(yè)務(wù)和技術(shù)方面的條件與限制以及進度、管理等方面的限制。2.1.4 詳細(xì)設(shè)計方法和工具簡要說明詳細(xì)設(shè)計所采用的方法和使用的工具，如數(shù)據(jù)庫設(shè)計工具、界面設(shè)計工具、原型設(shè)計工具等。3 系統(tǒng)詳細(xì)需求分析主要對系統(tǒng)級的需求進行分析。首先應(yīng)對需求分析提出的企業(yè)需求進一步確認(rèn)，并對由于情況變化而帶來的需求變化進行較為詳細(xì)的分析。3.1 詳細(xì)需求分析包括：· 詳細(xì)功能需求分析· 詳細(xì)性能需求分析·

5、 詳細(xì)資源需求分析· 詳細(xì)系統(tǒng)運行環(huán)境及限制條件分析3.2 詳細(xì)系統(tǒng)運行環(huán)境及限制條件分析接口需求分析包括：· 系統(tǒng)接口需求分析· 現(xiàn)有硬、軟件資源接口需求分析· 引進硬、軟件資源接口需求分析4 總體方案確認(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)變化。包括： 系統(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

6、 系統(tǒng)詳細(xì)界面劃分4.2.1 應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細(xì)界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)之間的界面包括系統(tǒng)主服務(wù)器與其他服務(wù)器的服務(wù)范圍及訪問方式，網(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)性能要求等。5 系統(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 系統(tǒng)功能模塊詳細(xì)設(shè)計按結(jié)構(gòu)化設(shè)計方法，在系統(tǒng)功能逐層分解的基礎(chǔ)上，對系統(tǒng)各功能模塊或子系統(tǒng)進行設(shè)計。此

7、為詳細(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)系。每個模塊的描述說明可參照以下格式：模塊編號：模塊名稱：輸入：處理：算法描述：輸出：數(shù)據(jù)表：其中處理和算法描述部分主要采用偽碼或具體的程序語言完成。對詳細(xì)設(shè)計更高的要求建議用IDEF0圖進行各功

8、能模塊的設(shè)計。如果對軟件需進行二次開發(fā)（包括功能擴展、功能改造、用戶界面改造等），則相應(yīng)的設(shè)計工作應(yīng)該設(shè)立子課題完成。5.3 系統(tǒng)界面詳細(xì)設(shè)計系統(tǒng)界面說明應(yīng)用系統(tǒng)軟件的各種呈現(xiàn)的界面，表現(xiàn)的形式和風(fēng)格進行設(shè)計，此部分可以在這里使用一個單獨章節(jié)進行設(shè)計，也可以融入到上面的系統(tǒng)功能模塊詳細(xì)設(shè)計中。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è)計和用戶需要的打印輸出等設(shè)計。

9、此部分內(nèi)容可能比較多。6、 數(shù)據(jù)庫系統(tǒng)設(shè)計此數(shù)據(jù)庫設(shè)計可單獨成冊，尤其對大型的數(shù)據(jù)庫應(yīng)用系統(tǒng)，即有一個單獨的數(shù)據(jù)庫設(shè)計說明書。6.1設(shè)計要求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ù)