軟件系統(tǒng)詳細設(shè)計說明書模板

1、系統(tǒng)詳細設(shè)計說明書文件狀態(tài)：V草稿正式發(fā)布文件標識：當(dāng)前版本：作者： 正在修改完成日期：版本歷史版本狀態(tài)參與者起止日期備注開始編寫修改記錄日期修訂版本修改章節(jié)修改描述目錄引言1.1 編寫目的 說明編寫詳細設(shè)計方案的主要目的。說明書編制的目的是說明一個軟件系統(tǒng)各個層次 中的每個程序（每個模塊或子程序）和數(shù)據(jù)庫系統(tǒng)的設(shè)計考慮，為程序員編碼提供依據(jù)。如果一個軟件系統(tǒng)比較簡單，層次很少，本文件可以不單獨編寫，和概要設(shè)計說明書中不重復(fù)部分合并 編寫。方案重點是模塊的執(zhí)行流程和數(shù)據(jù)庫系統(tǒng)詳細設(shè)計的描述。1.2 背景應(yīng)包含以下幾個方面的內(nèi)容：.待開發(fā)軟件系統(tǒng)名稱；.該系統(tǒng)基本概念，如該系統(tǒng)的類型、從屬地位等

2、；.開發(fā)項目組名稱。L3參考資料列出詳細設(shè)計報告引用的文獻或資料，資料的作者、標題、出版單位和出版日期等信 息，必要時說明如何得到這些資料。1.4術(shù)語定義及說明列出本文檔中用到的可能會引起混淆的專門術(shù)語、定義和縮寫詞的原文。2 設(shè)計概述2.1 任務(wù)和目標說明詳細設(shè)計的任務(wù)及詳細設(shè)計所要達到的目標。2.1.1 需求概述對所開發(fā)軟件的概要描述，包括主要的業(yè)務(wù)需求、輸入、輸出、主要功能、性能等，尤其需要描述 系統(tǒng)性能需求。2.1.2 運行環(huán)境概述對本系統(tǒng)所依賴于運行的硬件，包括操作系統(tǒng)、數(shù)據(jù)庫系統(tǒng)、中間件、接口 軟件、可能的性能監(jiān)控與分析等軟件環(huán)境的描述，及配置要求。2.1.3 條件與限制詳細描述系

3、統(tǒng)所受的內(nèi)部和外部條件的約束和限制說明。包括業(yè)務(wù)和技術(shù)方面的條件與限制以及進 度、管理等方面的限制。2.1.4 詳細設(shè)計方法和工具簡要說明詳細設(shè)計所采用的方法和使用的工具。如圖方法、（）方法、一圖，數(shù)據(jù)流程圖、業(yè)務(wù)流程圖、選用的工具等，盡量采用標準規(guī)范和輔助工具。3 系統(tǒng)詳細需求分析主要對系統(tǒng)級的需求進行分析。首先應(yīng)對需求分析提出的企業(yè)需求進一步確認，并對由于情況變化而帶 來的需求變化進行較為詳細的分析。3.1 詳細需求分析包括： 詳細功能需求分析 詳細性能需求分析 詳細資源需求分析 詳細系統(tǒng)運行環(huán)境及限制條件分析3.2 詳細系統(tǒng)運行環(huán)境及限制條件分析接口需求分析包括：系統(tǒng)接口需求分析現(xiàn)有硬、

4、軟件資源接口需求分析引進硬、軟件資源接口需求分析4 總體方案確認著重解決系統(tǒng)總體結(jié)構(gòu)確認及界面劃分問題。4.1 系統(tǒng)總體結(jié)構(gòu)確認對系統(tǒng)組成、邏輯結(jié)構(gòu)及層次進行確認，對應(yīng)用系統(tǒng)、支撐系統(tǒng)及各自實現(xiàn)的功能進行確認,細化集 成設(shè)計及系統(tǒng)工作流程，特別要注意因軟件的引進造成的系統(tǒng)本身結(jié)構(gòu)和公司其他系統(tǒng)的結(jié)構(gòu)變化。包括：系統(tǒng)組成、邏輯結(jié)構(gòu)及層次確認應(yīng)用系統(tǒng)結(jié)構(gòu)確認支撐系統(tǒng)結(jié)構(gòu)確認系統(tǒng)集成確認系統(tǒng)工作流程確認4.2 系統(tǒng)詳細界面劃分4.2.1 應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)之間的界面包括系統(tǒng)主服務(wù)器與其他服務(wù)器的服務(wù)范圍及訪問方式，網(wǎng)絡(luò)及數(shù)據(jù)庫 對應(yīng)用系統(tǒng)的支撐方式，全局數(shù)據(jù)的管理與存

5、取方式等。422系統(tǒng)內(nèi)部詳細界面劃分系統(tǒng)各功能之間的界面包括覆蓋范圍，模塊間功能調(diào)用涉及到的系統(tǒng)模塊及方法，全局數(shù)據(jù)格式，系統(tǒng)性能要求等。5 系統(tǒng)詳細設(shè)計5.1 系統(tǒng)程序代碼架構(gòu)設(shè)計系統(tǒng)采用三層架構(gòu)模型，將應(yīng)用系統(tǒng)劃分為用戶界面表示層、業(yè)務(wù)邏輯層、數(shù)據(jù)訪問層，以及實體類、類庫組成，各層的關(guān)系如下圖所示：VIfUseT Interface)用戶齊面表示哥BLL(Business Logic司Enttrs- Class實俸類1DAL (Data AccessL赳er)數(shù)據(jù)訪問層Common類庫十15.1.1 。用戶界面表示層負責(zé)與用戶進行交互，顯示、接受數(shù)據(jù)，與此同時，做一些簡單邏輯處理，如：輸入

6、數(shù)據(jù)有效性判斷、顯 示各種異常、處理記錄集數(shù)據(jù)。它只與o業(yè)務(wù)邏輯層、實體類兩個項目發(fā)生關(guān)聯(lián)，可能與類庫發(fā)生關(guān)聯(lián)。5.1.2 。業(yè)務(wù)邏輯層是整個系統(tǒng)的核心，它承擔(dān)了所有的邏輯判斷，實現(xiàn)了程序的功能，它是靈活的。層既是調(diào)用者，又是被 調(diào)用者，因此，要適當(dāng)?shù)倪M行設(shè)計達到解耦的效果。層只關(guān)聯(lián)層和實體類，可能關(guān)聯(lián)類庫。雖然層被層調(diào)用，但是層無需關(guān)心層的情況。數(shù)據(jù)庫中每個表都對應(yīng)一個類，為了達到解耦效果，類不能直接調(diào)用其他表的類, 可以類之間相互調(diào)用。5.1.3 （）數(shù)據(jù)訪問層提供數(shù)據(jù)訪問的接口，沒有任何邏輯。在接口中對數(shù)據(jù)庫操作語句進行組合裝配。層一般關(guān)類庫中的最底層，最基礎(chǔ)的數(shù)據(jù)庫類（比如：鏈接數(shù)據(jù)庫

7、），必須關(guān)聯(lián)實體類項目。層只是數(shù)據(jù)庫的管理者，但不是訪問者，不直接與數(shù)據(jù)庫發(fā)生關(guān)聯(lián)。數(shù)據(jù)庫中每個表都對應(yīng)-個層的接口（訪問控制）類。5.1.4 類庫用于存放公用的類。最常用的就是數(shù)據(jù)庫訪問類，比如：鏈接字符串，數(shù)據(jù)庫引擎類。它直接與數(shù)據(jù)庫進 行機械式的交換，無任何邏輯。5.1.5 實體類相當(dāng)于加強的數(shù)據(jù)結(jié)構(gòu)，實現(xiàn)了對數(shù)據(jù)的封裝。數(shù)據(jù)庫中每個表都對應(yīng)一個實體類，表的字段就是實體類 的屬性，類型一一對應(yīng)。、這三層的交互主要就是通過實體類作為參數(shù)，并回信息。5.2 系統(tǒng)結(jié)構(gòu)設(shè)計及子系統(tǒng)劃分根據(jù)業(yè)務(wù)和功能，將系統(tǒng)的邏輯結(jié)構(gòu)劃分為子系統(tǒng)、子系等個子系統(tǒng)，如下圖所示：各個子系統(tǒng)按照功能角度分解，戈U分出若

8、干不同的功能模塊，如下面各圖所示:5.3 系統(tǒng)功能模塊詳細設(shè)計按結(jié)構(gòu)化設(shè)計方法，在系統(tǒng)功能逐層分解的基礎(chǔ)上，對系統(tǒng)各功能模塊或子系統(tǒng)進行設(shè)計。此為詳細設(shè)計的主要部分之一用層次圖描述系統(tǒng)的總體結(jié)構(gòu)、功能分解及各個模塊之間的相互調(diào)用關(guān)系和信息交互，用圖或其他方 法描述各模塊完成的功能。以上建議采用圖進行功能分解與模塊描述，更高的要求建議采用方法進行功能模 型設(shè)計。詳細設(shè)計應(yīng)用系統(tǒng)的各個構(gòu)成模塊完成的功能及其相互之間的關(guān)系，用或結(jié)構(gòu)圖描述各模塊的組成 結(jié)構(gòu)、算法、模塊間的接口關(guān)系，以及需求、功能和模塊三者之間的交叉參照關(guān)系。每個模塊的描述說明可參照以下格式：模塊編號：模塊名稱：輸入：處理：算法描述：

9、輸出：其中處理和算法描述部分主要采用偽碼或具體的程序語言完成。對詳細設(shè)計更高的要求建議用圖進行 各功能模塊的設(shè)計。如果對軟件需進行二次開發(fā)（包括功能擴展、功能改造、用戶界面改造等），則相應(yīng)的設(shè)計工作應(yīng)該設(shè) 立子課題完成。注意：算法描述主要是說明層的代碼邏輯，層只做簡單的輸入驗證和界面顯示功能。5.3.1 子系統(tǒng)1模塊列表和分頁創(chuàng)建2模塊列表修改5.3.2 子系統(tǒng)5.3.3 用戶管理模塊模塊描述：管理系統(tǒng)用戶，包括添加用戶并賦予角色、修改用戶資料和角色、刪除用戶。主要功能：添 加用戶、修改用戶、刪除用戶、列表和分頁。5.3.6.1.1列表和分頁1、流程圖省略2、輸入項頁面?zhèn)鲄?shù)頁面加載時為分頁索

10、引3、輸出項1）列表詳細記錄；2）當(dāng)前頁碼；3）分頁總數(shù)；4）記錄總數(shù)。4、算法描述系統(tǒng)管理用戶數(shù)據(jù)量不大，而且該功能使用頻率不高，可以不用優(yōu)化分頁，直接獲取用戶表全部記錄, 建議層使用控件，調(diào)用（）綁定控件，利用自帶分頁功能，顯示分頁按鈕、當(dāng)前頁、分頁總數(shù)、記錄總數(shù)、5.3,6,1.2添加用戶1、流程圖2、輸入項用戶必填姓名必填用戶密碼必填確認密碼必填聯(lián)系電話狀態(tài)用戶角色3、輸出項1）成功，提示添加用戶完成；2）失敗，提示具體信息。4、算法描述1）前端判斷必填項的輸入和二次密碼是否相同，角色可以不選；2）須驗證必填項，用戶名是唯一的不能重復(fù)；3）加密密碼使用（，），”“；4）用戶信息保存至表

11、，（）；5）分拆角色字符串并循環(huán)字符串?dāng)?shù)組，信息保存至表，（）5.3,6.1.3修改用戶1、流程圖輸入用戶資料 選擇角色2、輸入項用戶頁面?zhèn)鲄?shù)姓名必填必填必填用戶密碼 確認密碼 聯(lián)系電話狀態(tài)用戶角色3、輸出項1）成功，提示修改用戶完成;2）失敗，提示具體信息。4、算法描述1）前端判斷必填項的輸入和二次密碼是否相同，角色可以不選;2）加密密碼使用.（,），”；3）根據(jù)用戶刪除表的記錄（）；4）分拆角色字符串并循環(huán)字符串?dāng)?shù)組，信息保存至該表（）5.3.6.1.4刪除用戶1、流程圖c返回成功信息根據(jù)用戶刪除表記錄操作記錄日志2、輸入項用戶頁面?zhèn)鲄?shù)3、輸出項1、成功，提示刪除用戶完成，刷新列表;9

12、失敗，提示具體信息。3、算法描述1）根據(jù)用戶刪除表的記錄 0；2）根據(jù)用戶刪除表的記錄 0。5.362角色管理模塊5.3.6.3 系統(tǒng)設(shè)置模塊5.3.6.4 系統(tǒng)登錄注銷模塊5.4系統(tǒng)界面詳細設(shè)計系統(tǒng)界面說明應(yīng)用系統(tǒng)軟件的各種接口。整個系統(tǒng)的其他接口 （如系統(tǒng)硬件接口、通訊接口等）在相應(yīng) 的部分說明。5.4.1 外部界面設(shè)計根據(jù)系統(tǒng)界面劃分進行系統(tǒng)外部界面設(shè)計，對系統(tǒng)的所有外部接口（包括功能 和數(shù)據(jù)接口）進行設(shè)計。5.4.2 內(nèi)部界面設(shè)計設(shè)計系統(tǒng)內(nèi)部各功能模塊間的調(diào)用關(guān)系和數(shù)據(jù)接口。5.4.3 用戶界面設(shè)計規(guī)定人機界面的內(nèi)容、界面風(fēng)格、調(diào)用方式等，包括所謂的表單設(shè)計、報表設(shè) 計和用戶需要的打印

13、輸出等設(shè)計。此部分內(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)系，詳細描述數(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)換。詳細列出所使用的數(shù)據(jù)結(jié)構(gòu)中每個數(shù)據(jù)項、記錄和文件的標識、定義、長度及它 們之間的相互關(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è)備及外存