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

1、精選優(yōu)質(zhì)文檔-傾情為你奉上精選優(yōu)質(zhì)文檔-傾情為你奉上專心-專注-專業(yè)專心-專注-專業(yè)精選優(yōu)質(zhì)文檔-傾情為你奉上專心-專注-專業(yè)xxxxx系統(tǒng)詳細(xì)設(shè)計(jì)說明書文件狀態(tài)： 草稿 正式發(fā)布 正在修改文件標(biāo)識(shí)：當(dāng)前版本：1.0作 者：完成日期：版 本 歷 史版本/狀態(tài)作者參與者起止日期備注1.0開始編寫修 改 記 錄日期修訂版本修改章節(jié)修改描述作者目錄 TOC o 1-4 h z u 引言編寫目的說明編寫詳細(xì)設(shè)計(jì)方案的主要目的。說明書編制的目的是說明一個(gè)軟件系統(tǒng)各個(gè)層次中的每個(gè)程序（每個(gè)模塊或子程序）和數(shù)據(jù)庫系統(tǒng)的設(shè)計(jì)考慮，為程序員編碼提供依據(jù)。如果一個(gè)軟件系統(tǒng)比較簡(jiǎn)單，層次很少，本文件可以不單獨(dú)編寫，

2、和概要設(shè)計(jì)說明書中不重復(fù)部分合并編寫。 方案重點(diǎn)是模塊的執(zhí)行流程和數(shù)據(jù)庫系統(tǒng)詳細(xì)設(shè)計(jì)的描述。背景應(yīng)包含以下幾個(gè)方面的內(nèi)容：A. 待開發(fā)軟件系統(tǒng)名稱；B. 該系統(tǒng)基本概念， 如該系統(tǒng)的類型、從屬地位等；C. 開發(fā)項(xiàng)目組名稱。參考資料列出詳細(xì)設(shè)計(jì)報(bào)告引用的文獻(xiàn)或資料，資料的作者、標(biāo)題、出版單位和出版日期等信息，必要時(shí)說明如何得到這些資料。術(shù)語定義及說明列出本文檔中用到的可能會(huì)引起混淆的專門術(shù)語、定義和縮寫詞的原文。設(shè)計(jì)概述任務(wù)和目標(biāo)說明詳細(xì)設(shè)計(jì)的任務(wù)及詳細(xì)設(shè)計(jì)所要達(dá)到的目標(biāo) 。需求概述對(duì)所開發(fā)軟件的概要描述, 包括主要的業(yè)務(wù)需求、輸入、 輸出、主要功能、性能等，尤其需要描述系統(tǒng)性能需求。運(yùn)行環(huán)境概

3、述對(duì)本系統(tǒng)所依賴于運(yùn)行的硬件，包括操作系統(tǒng)、數(shù)據(jù)庫系統(tǒng)、中間件、接口軟件、可能的性能監(jiān)控與分析等軟件環(huán)境的描述，及配置要求。條件與限制詳細(xì)描述系統(tǒng)所受的內(nèi)部和外部條件的約束和限制說明。包括業(yè)務(wù)和技術(shù)方面的條件與限制以及進(jìn)度、管理等方面的限制。詳細(xì)設(shè)計(jì)方法和工具簡(jiǎn)要說明詳細(xì)設(shè)計(jì)所采用的方法和使用的工具。如HIPO圖方法、IDEF（I2DEF）方法、ER圖，數(shù)據(jù)流程圖、業(yè)務(wù)流程圖、選用的CASE工具等，盡量采用標(biāo)準(zhǔn)規(guī)范和輔助工具。系統(tǒng)詳細(xì)需求分析主要對(duì)系統(tǒng)級(jí)的需求進(jìn)行分析。首先應(yīng)對(duì)需求分析提出的企業(yè)需求進(jìn)一步確認(rèn)，并對(duì)由于情況變化而帶來的需求變化進(jìn)行較為詳細(xì)的分析。詳細(xì)需求分析包括：詳細(xì)功能需求分

4、析詳細(xì)性能需求分析詳細(xì)資源需求分析詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析接口需求分析包括：系統(tǒng)接口需求分析現(xiàn)有硬、軟件資源接口需求分析引進(jìn)硬、軟件資源接口需求分析 總體方案確認(rèn)著重解決系統(tǒng)總體結(jié)構(gòu)確認(rèn)及界面劃分問題。 系統(tǒng)總體結(jié)構(gòu)確認(rèn)對(duì)系統(tǒng)組成、邏輯結(jié)構(gòu)及層次進(jìn)行確認(rèn)，對(duì)應(yīng)用系統(tǒng)、支撐系統(tǒng)及各自實(shí)現(xiàn)的功能進(jìn)行確認(rèn)，細(xì)化集成設(shè)計(jì)及系統(tǒng)工作流程，特別要注意因軟件的引進(jìn)造成的系統(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) 系統(tǒng)詳細(xì)界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細(xì)界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)之間的

5、界面包括系統(tǒng)主服務(wù)器與其他服務(wù)器的服務(wù)范圍及訪問方式，網(wǎng)絡(luò)及數(shù)據(jù)庫對(duì)應(yīng)用系統(tǒng)的支撐方式，全局?jǐn)?shù)據(jù)的管理與存取方式等。系統(tǒng)內(nèi)部詳細(xì)界面劃分系統(tǒng)各功能之間的界面包括覆蓋范圍，模塊間功能調(diào)用涉及到的系統(tǒng)模塊及方法，全局?jǐn)?shù)據(jù)格式，系統(tǒng)性能要求等。系統(tǒng)詳細(xì)設(shè)計(jì)系統(tǒng)程序代碼架構(gòu)設(shè)計(jì)系統(tǒng)采用三層架構(gòu)模型，將應(yīng)用系統(tǒng)劃分為用戶界面表示層、業(yè)務(wù)邏輯層、數(shù)據(jù)訪問層，以及Entity Class實(shí)體類、Common類庫組成，各層的關(guān)系如下圖所示：UI(User Interface)用戶界面表示層負(fù)責(zé)與用戶進(jìn)行交互，顯示、接受數(shù)據(jù)，與此同時(shí)，做一些簡(jiǎn)單邏輯處理，如：輸入數(shù)據(jù)有效性判斷、顯示各種異常、處理Dataset

6、記錄集數(shù)據(jù)。它只與BLL(Business Logic Layer)業(yè)務(wù)邏輯層、Entity Class實(shí)體類兩個(gè)項(xiàng)目發(fā)生關(guān)聯(lián)，可能與Common類庫發(fā)生關(guān)聯(lián)。BLL(Business Logic Layer)業(yè)務(wù)邏輯層是整個(gè)系統(tǒng)的核心，它承擔(dān)了所有的邏輯判斷，實(shí)現(xiàn)了程序的功能，它是靈活的。BLL層既是調(diào)用者，又是被調(diào)用者，因此，要適當(dāng)?shù)倪M(jìn)行設(shè)計(jì)達(dá)到解耦的效果。BLL層只關(guān)聯(lián)DAL層和實(shí)體類，可能關(guān)聯(lián)Common類庫。雖然BLL層被U層調(diào)用，但是BLL層無需關(guān)心UI層的情況。數(shù)據(jù)庫中每個(gè)表都對(duì)應(yīng)一個(gè)BLL類，為了達(dá)到解耦效果，BLL類不能直接調(diào)用其他表的DAL類，可以BLL類之間相互調(diào)用。DA

7、L(Data Access Layer)數(shù)據(jù)訪問層提供數(shù)據(jù)訪問的接口，沒有任何邏輯。在接口中對(duì)數(shù)據(jù)庫操作語句進(jìn)行組合裝配。DAL層一般關(guān)聯(lián)Common類庫中的最底層，最基礎(chǔ)的數(shù)據(jù)庫類（比如：鏈接數(shù)據(jù)庫），必須關(guān)聯(lián)Entity Class實(shí)體類項(xiàng)目。DAL層只是數(shù)據(jù)庫的管理者，但不是訪問者，不直接與數(shù)據(jù)庫發(fā)生關(guān)聯(lián)。數(shù)據(jù)庫中每個(gè)表都對(duì)應(yīng)一個(gè)DAL層的接口(訪問控制)類。Common類庫用于存放公用的類。最常用的就是數(shù)據(jù)庫訪問類，比如：鏈接字符串，數(shù)據(jù)庫引擎類。它直接與數(shù)據(jù)庫進(jìn)行機(jī)械式的交換，無任何邏輯。Entity Class實(shí)體類相當(dāng)于加強(qiáng)的數(shù)據(jù)結(jié)構(gòu)，實(shí)現(xiàn)了對(duì)數(shù)據(jù)的封裝。數(shù)據(jù)庫中每個(gè)表都對(duì)應(yīng)一個(gè)

8、實(shí)體類，表的字段就是實(shí)體類的屬性，類型一一對(duì)應(yīng)。UI、BLL、DAL這三層的交互主要就是通過實(shí)體類作為參數(shù)，并Return回信息。系統(tǒng)結(jié)構(gòu)設(shè)計(jì)及子系統(tǒng)劃分根據(jù)業(yè)務(wù)和功能，將系統(tǒng)的邏輯結(jié)構(gòu)劃分為XX子系統(tǒng)、XX子系等6個(gè)子系統(tǒng)，如下圖所示：XXXXXXXX系統(tǒng)XX管理子系統(tǒng)XX管理子系統(tǒng)XX子系統(tǒng)XX子系統(tǒng)XX子系統(tǒng)XX子系統(tǒng)各個(gè)子系統(tǒng)按照功能角度分解，劃分出若干不同的功能模塊，如下面各圖所示： 系統(tǒng)功能模塊詳細(xì)設(shè)計(jì)按結(jié)構(gòu)化設(shè)計(jì)方法，在系統(tǒng)功能逐層分解的基礎(chǔ)上，對(duì)系統(tǒng)各功能模塊或子系統(tǒng)進(jìn)行設(shè)計(jì)。此為詳細(xì)設(shè)計(jì)的主要部分之一。用層次圖描述系統(tǒng)的總體結(jié)構(gòu)、功能分解及各個(gè)模塊之間的相互調(diào)用關(guān)系和信息交互

9、，用IPO圖或其他方法描述各模塊完成的功能。 以上建議采用HIPO圖進(jìn)行功能分解與模塊描述，更高的要求建議采用IDEF0方法進(jìn)行功能模型設(shè)計(jì)。詳細(xì)設(shè)計(jì)應(yīng)用系統(tǒng)的各個(gè)構(gòu)成模塊完成的功能及其相互之間的關(guān)系，用IPO或結(jié)構(gòu)圖描述各模塊的組成結(jié)構(gòu)、算法、模塊間的接口關(guān)系，以及需求、功能和模塊三者之間的交叉參照關(guān)系。每個(gè)模塊的描述說明可參照以下格式：模塊編號(hào)：模塊名稱：輸入：處理：算法描述：輸出：其中處理和算法描述部分主要采用偽碼或具體的程序語言完成。對(duì)詳細(xì)設(shè)計(jì)更高的要求建議用IDEF0圖進(jìn)行各功能模塊的設(shè)計(jì)。如果對(duì)軟件需進(jìn)行二次開發(fā)（包括功能擴(kuò)展、功能改造、用戶界面改造等），則相應(yīng)的設(shè)計(jì)工作應(yīng)該設(shè)立子

10、課題完成。注意：算法描述主要是說明BLL層的代碼邏輯，UI層只做簡(jiǎn)單的輸入驗(yàn)證和界面顯示功能。XX子系統(tǒng)XX模塊列表和分頁創(chuàng)建XXXX模塊XX列表XX修改XX子系統(tǒng)用戶管理模塊模塊描述：管理系統(tǒng)用戶，包括添加用戶并賦予角色、修改用戶資料和角色、刪除用戶。主要功能：添加用戶、修改用戶、刪除用戶、列表和分頁。列表和分頁流程圖省略輸入項(xiàng)分頁索引頁面?zhèn)鲄?shù)頁面加載時(shí)為1輸出項(xiàng)列表詳細(xì)記錄；當(dāng)前頁碼；分頁總數(shù)；記錄總數(shù)。算法描述系統(tǒng)管理用戶數(shù)據(jù)量不大，而且該功能使用頻率不高，可以不用優(yōu)化分頁，直接獲取用戶表全部記錄，建議UI層使用gridview控件，調(diào)用ExamSys.BLL.System_admin

11、_info GetAllList()綁定控件，利用gridview自帶分頁功能，顯示分頁按鈕、當(dāng)前頁、分頁總數(shù)、記錄總數(shù)、添加用戶流程圖輸入用戶資料選擇角色加密密碼填寫合規(guī)用戶信息保存至表System_admin_info驗(yàn)證必填項(xiàng)驗(yàn)證用戶名是否存在是否成功分拆角色I(xiàn)D字符串循環(huán)字符串?dāng)?shù)組信息保存至表Dict_admin_vs_roles返回成功信息是否是返回失敗信息否是否操作記錄日志輸入項(xiàng)用戶IDstring必填姓名string必填用戶密碼string必填確認(rèn)密碼string必填聯(lián)系電話stringE-mail string狀態(tài)char用戶角色I(xiàn)Dstring輸出項(xiàng)成功，UI提示添加用戶完成

12、；失敗，UI提示具體信息。算法描述前端js判斷必填項(xiàng)的輸入和二次密碼是否相同，角色可以不選；BLL須驗(yàn)證必填項(xiàng)，用戶名是唯一的不能重復(fù)；加密密碼使用MD5.Encrypt(string String, string Key)，Key = XXXXXXXX；用戶信息保存至表System_admin_info，ExamSys.DAL.System_admin_info Add(ExamSys.Model.System_admin_info model) ；分拆角色I(xiàn)D字符串并循環(huán)字符串?dāng)?shù)組，信息保存至表Dict_admin_vs_roles，ExamSys.BLL.Dict_admin_vs_ro

13、les Add(ExamSys.Model.Dict_admin_vs_roles model)。修改用戶流程圖輸入用戶資料選擇角色填寫合規(guī)用戶信息保存至表System_admin_info驗(yàn)證必填項(xiàng)加密密碼是否成功分拆角色I(xiàn)D字符串循環(huán)字符串?dāng)?shù)組信息保存至表Dict_admin_vs_roles返回成功信息是是返回失敗信息否否根據(jù)用戶ID刪除表Dict_admin_vs_roles記錄是否成功是否操作記錄日志輸入項(xiàng)用戶IDstring頁面?zhèn)鲄?shù)姓名string必填用戶密碼string必填確認(rèn)密碼string必填聯(lián)系電話stringE-mail string狀態(tài)char用戶角色I(xiàn)Dstring

14、輸出項(xiàng)成功，UI提示修改用戶完成；失敗，UI提示具體信息。算法描述前端js判斷必填項(xiàng)的輸入和二次密碼是否相同，角色可以不選；加密密碼使用Chukeh.Security.MD5. Encrypt(string String, string Key)，Key = LinLiYan；根據(jù)用戶ID刪除表Dict_admin_vs_roles的記錄ExamSys.BLL.Dict_admin_vs_roles DeleteByAdminID(string admin_id) ；分拆角色I(xiàn)D字符串并循環(huán)字符串?dāng)?shù)組，信息保存至該表ExamSys.BLL.Dict_admin_vs_roles Add(Exa

15、mSys.Model.Dict_admin_vs_roles model)。刪除用戶流程圖列表中點(diǎn)擊刪除按鈕是否成功返回成功信息是返回失敗信息否根據(jù)用戶ID刪除表Dict_admin_vs_roles記錄是否成功是否根據(jù)用戶ID刪除表System_admin_info記錄操作記錄日志輸入項(xiàng)用戶IDstring頁面?zhèn)鲄?shù)輸出項(xiàng)成功，UI提示刪除用戶完成，刷新列表；失敗，UI提示具體信息。算法描述根據(jù)用戶ID刪除表System_admin_info的記錄ExamSys.DAL.System_admin_info Delete(string admin_id) ；根據(jù)用戶ID刪除表Dict_admi

16、n_vs_roles的記錄ExamSys.BLL.Dict_admin_vs_roles DeleteByAdminID(string admin_id) 。角色管理模塊系統(tǒng)設(shè)置模塊系統(tǒng)登錄注銷模塊系統(tǒng)界面詳細(xì)設(shè)計(jì)系統(tǒng)界面說明應(yīng)用系統(tǒng)軟件的各種接口。整個(gè)系統(tǒng)的其他接口（如系統(tǒng)硬件接口、通訊接口等）在相應(yīng)的部分說明。外部界面設(shè)計(jì)根據(jù)系統(tǒng)界面劃分進(jìn)行系統(tǒng)外部界面設(shè)計(jì)，對(duì)系統(tǒng)的所有外部接口（包括功能和數(shù)據(jù)接口）進(jìn)行設(shè)計(jì)。內(nèi)部界面設(shè)計(jì)設(shè)計(jì)系統(tǒng)內(nèi)部各功能模塊間的調(diào)用關(guān)系和數(shù)據(jù)接口。用戶界面設(shè)計(jì)規(guī)定人機(jī)界面的內(nèi)容、界面風(fēng)格、調(diào)用方式等，包括所謂的表單設(shè)計(jì)、報(bào)表設(shè)計(jì)和用戶需要的打印輸出等設(shè)計(jì)。此部分內(nèi)容可能

17、比較多。數(shù)據(jù)庫系統(tǒng)設(shè)計(jì)此數(shù)據(jù)庫設(shè)計(jì)可單獨(dú)成冊(cè)，尤其對(duì)大型的數(shù)據(jù)庫應(yīng)用系統(tǒng)，即有一個(gè)單獨(dú)的數(shù)據(jù)庫設(shè)計(jì)說明書。 設(shè)計(jì)要求 信息模型設(shè)計(jì)確定系統(tǒng)信息的類型（實(shí)體或視圖），確定系統(tǒng)信息實(shí)體的屬性、關(guān)鍵字及實(shí)體之間的聯(lián)系， 詳細(xì)描述數(shù)據(jù)庫和結(jié)構(gòu)設(shè)計(jì)，數(shù)據(jù)元素及屬性定義，數(shù)據(jù)關(guān)系模式，數(shù)據(jù)約束和限制。 數(shù)據(jù)庫設(shè)計(jì) 設(shè)計(jì)依據(jù)說明數(shù)據(jù)被訪問的頻度和流量，最大數(shù)據(jù)存儲(chǔ)量，數(shù)據(jù)增長(zhǎng)量，存儲(chǔ)時(shí)間等數(shù)據(jù)庫設(shè)計(jì)依據(jù)。 數(shù)據(jù)庫種類及特點(diǎn)說明系統(tǒng)內(nèi)應(yīng)用的數(shù)據(jù)庫種類、各自的特點(diǎn)、數(shù)量及如何實(shí)現(xiàn)互聯(lián)，數(shù)據(jù)如何傳遞。 數(shù)據(jù)庫邏輯結(jié)構(gòu)說明數(shù)據(jù)庫概念模式向邏輯模式轉(zhuǎn)換所采用的方法論及工具，完成數(shù)據(jù)庫概念模式向邏輯模式的轉(zhuǎn)換。 詳細(xì)列出所使用的數(shù)據(jù)結(jié)構(gòu)中每個(gè)數(shù)據(jù)項(xiàng)、記錄和文件的標(biāo)識(shí)、定義、長(zhǎng)度及它們之間的相互關(guān)系。此節(jié)內(nèi)容為數(shù)據(jù)庫設(shè)計(jì)的主要部分。 物理結(jié)構(gòu)設(shè)計(jì) 列出所使用的數(shù)據(jù)結(jié)構(gòu)中每個(gè)數(shù)據(jù)