《軟件項目詳細設計文檔示例模版.doc》由會員分享,可在線閱讀,更多相關《軟件項目詳細設計文檔示例模版.doc(8頁珍藏版)》請在裝配圖網上搜索。
1、(此處填入項目名稱)XXX軟件/項目/系統(tǒng)詳細設計說明書 擬制日期評審人日期批準日期編寫單位或個人修訂歷史日期版本作者章節(jié)備注 目錄XXX軟件詳細設計說明書1Revision Record 修訂記錄21引言31.1編寫目的31.2背景41.3參考資料41.4術語定義及說明42設計概述42.1任務和目標42.1.1需求概述42.1.2運行環(huán)境概述42.1.3條件與限制42.1.4詳細設計方法和工具43系統(tǒng)詳細需求分析43.1詳細需求分析53.2詳細系統(tǒng)運行環(huán)境及限制條件分析接口需求分析54總體方案確認54.1系統(tǒng)總體結構確認54.2系統(tǒng)詳細界面劃分54.2.1應用系統(tǒng)與支撐系統(tǒng)的詳細界面劃分54
2、.2.2系統(tǒng)內部詳細界面劃分55系統(tǒng)詳細設計55.1系統(tǒng)結構設計及子系統(tǒng)劃分65.2系統(tǒng)功能模塊詳細設計65.3系統(tǒng)界面詳細設計65.3.1外部界面設計65.3.2內部界面設計65.3.3用戶界面設計66、數據庫系統(tǒng)設計76.1設計要求76.2 信息模型設計76.3數據庫設計76.3.1設計依據76.3.2數據庫種類及特點76.3.3數據庫邏輯結構76.3.4物理結構設計76.3.5數據庫安全76.3.6數據字典77非功能性設計7889環(huán)境配置81 引言1.1 編寫目的說明編制的目的是,大體上介紹一下軟件系統(tǒng)中各層次中模塊或子程序、以及數據庫系統(tǒng)的設計考慮,表明此文檔是主要是為編碼人員提供服務
3、,并且其他類型的項目參與人員也可以通過此文檔對軟件/項目有更深入了解。1.2 背景說明此軟件或系統(tǒng)的項目背景、需求背景、開發(fā)目的等,還可以列出參與人員等相關信息。1.3 參考資料列出本文檔中引用的文獻、資料、標準等相關信息(一般是具有出版或版權性質的文件)。1.4 術語定義及說明列出文檔中用到的和開發(fā)有關,或與行業(yè)、業(yè)務、需求有關的專業(yè)術語,并進行解釋。2 設計概述2.1 任務和目標說明詳細設計的任務及詳細設計所要達到的目標 。2.1.1 需求概述對所開發(fā)軟件的概要描述, 包括主要的業(yè)務需求、輸入、 輸出、主要功能、性能等,尤其需要描述系統(tǒng)性能需求。2.1.2 運行環(huán)境概述對本系統(tǒng)所依賴于運行
4、的硬件,包括操作系統(tǒng)、數據庫系統(tǒng)、運行庫、中間件、接口軟件、可能的性能監(jiān)控與分析等軟件環(huán)境的描述,及配置要求。2.1.3 條件與限制詳細描述系統(tǒng)所受的內部和外部條件的約束和限制說明。包括業(yè)務和技術方面的條件與限制以及進度、管理等方面的限制。2.1.4 詳細設計方法和工具簡要說明詳細設計所采用的方法和使用的工具,如數據庫設計工具、界面設計工具、原型設計工具等。3 系統(tǒng)詳細需求分析主要對系統(tǒng)級的需求進行分析。首先應對需求分析提出的企業(yè)需求進一步確認,并對由于情況變化而帶來的需求變化進行較為詳細的分析。3.1 詳細需求分析包括: 詳細功能需求分析 詳細性能需求分析 詳細資源需求分析 詳細系統(tǒng)運行環(huán)境
5、及限制條件分析3.2 詳細系統(tǒng)運行環(huán)境及限制條件分析接口需求分析包括: 系統(tǒng)接口需求分析 現有硬、軟件資源接口需求分析 引進硬、軟件資源接口需求分析4 總體方案確認著重解決系統(tǒng)總體結構確認及界面劃分問題。 4.1 系統(tǒng)總體結構確認對系統(tǒng)組成、邏輯結構及層次進行確認,對應用系統(tǒng)、支撐系統(tǒng)及各自實現的功能進行確認,細化集成設計及系統(tǒng)工作流程,特別要注意因軟件的引進造成的系統(tǒng)本身結構和公司其他系統(tǒng)的結構變化。包括: 系統(tǒng)組成、邏輯結構及層次確認 應用系統(tǒng)結構確認 支撐系統(tǒng)結構確認 系統(tǒng)集成確認 系統(tǒng)工作流程確認4.2 系統(tǒng)詳細界面劃分4.2.1 應用系統(tǒng)與支撐系統(tǒng)的詳細界面劃分應用系統(tǒng)與支撐系統(tǒng)之間
6、的界面包括系統(tǒng)主服務器與其他服務器的服務范圍及訪問方式,網絡及數據庫對應用系統(tǒng)的支撐方式,全局數據的管理與存取方式等。4.2.2 系統(tǒng)內部詳細界面劃分系統(tǒng)各功能之間的界面包括覆蓋范圍,模塊間功能調用涉及到的系統(tǒng)模塊及方法,全局數據格式,系統(tǒng)性能要求等。5 系統(tǒng)詳細設計5.1 系統(tǒng)結構設計及子系統(tǒng)劃分對系統(tǒng)的組成及邏輯結構進行設計前確認。劃分系統(tǒng)功能模塊或子系統(tǒng)(如果有或者有必要,特別是大型的軟件系統(tǒng))。5.2 系統(tǒng)功能模塊詳細設計按結構化設計方法,在系統(tǒng)功能逐層分解的基礎上,對系統(tǒng)各功能模塊或子系統(tǒng)進行設計。此為詳細設計的主要部分之一。用層次圖描述系統(tǒng)的總體結構、功能分解及各個模塊之間的相互調
7、用關系和信息交互,用IPO圖或其他方法描述各模塊完成的功能。 以上建議采用HIPO圖進行功能分解與模塊描述,更高的要求建議采用IDEF0方法進行功能模型設計。詳細設計應用系統(tǒng)的各個構成模塊完成的功能及其相互之間的關系,用IPO或結構圖描述各模塊的組成結構、算法、模塊間的接口關系,以及需求、功能和模塊三者之間的交叉參照關系。每個模塊的描述說明可參照以下格式:模塊編號:模塊名稱:輸入:處理:算法描述:輸出:數據表:其中處理和算法描述部分主要采用偽碼或具體的程序語言完成。對詳細設計更高的要求建議用IDEF0圖進行各功能模塊的設計。如果對軟件需進行二次開發(fā)(包括功能擴展、功能改造、用戶界面改造等),則
8、相應的設計工作應該設立子課題完成。5.3 系統(tǒng)界面詳細設計系統(tǒng)界面說明應用系統(tǒng)軟件的各種呈現的界面,表現的形式和風格進行設計,此部分可以在這里使用一個單獨章節(jié)進行設計,也可以融入到上面的系統(tǒng)功能模塊詳細設計中。5.3.1 外部界面設計根據系統(tǒng)界面劃分進行系統(tǒng)外部界面設計,對系統(tǒng)的所有外部接口(包括功能和數據接口)進行設計。5.3.2 內部界面設計設計系統(tǒng)內部各功能模塊間的調用關系和數據接口。5.3.3 用戶界面設計規(guī)定人機界面的內容、界面風格、調用方式等,包括所謂的表單設計、報表設計和用戶需要的打印輸出等設計。此部分內容可能比較多。6、 數據庫系統(tǒng)設計此數據庫設計可單獨成冊,尤其對大型的數據庫
9、應用系統(tǒng),即有一個單獨的數據庫設計說明書。6.1設計要求6.2 信息模型設計確定系統(tǒng)信息的類型(實體或視圖),確定系統(tǒng)信息實體的屬性、關鍵字及實體之間的聯系, 詳細描述數據庫和結構設計,數據元素及屬性定義,數據關系模式,數據約束和限制。 6.3 數據庫設計6.3.1 設計依據說明數據被訪問的頻度和流量,最大數據存儲量,數據增長量,存儲時間等數據庫設計依據。6.3.2 數據庫種類及特點說明系統(tǒng)內應用的數據庫種類、各自的特點、數量及如何實現互聯,數據如何傳遞。6.3.3 數據庫邏輯結構說明數據庫概念模式向邏輯模式轉換所采用的方法論及工具,完成數據庫概念模式向邏輯模式的轉換。 詳細列出所使用的數據結
10、構中每個數據項、記錄和文件的標識、定義、長度及它們之間的相互關系。此節(jié)內容為數據庫設計的主要部分。6.3.4 物理結構設計 列出所使用的數據結構中每個數據項的存儲要求、訪問方法、存取單位和存取物理關系等。建立系統(tǒng)程序員視圖,包括: 數據在內存中的安排,包括對索引區(qū)、緩沖區(qū)的設計; 所使用的外存設備及外存空間的組織,包括索引區(qū)、數據塊的組織與劃分; 訪問數據的方式方法。6.3.5 數據庫安全說明數據的共享方式,如何保證數據的安全性及保密性。6.3.6 數據字典編寫詳細的數據字典。 對數據庫設計中涉及到的各種項目,如數據項、記錄、系、文卷模式、子模式等一般要建立起數據字典,以說明它們的標識符、同義名及有關信息。7 非功能性設計8 環(huán)境配置開發(fā)。測試、運行環(huán)境