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

1、xxxxx系統(tǒng)詳細(xì)設(shè)計(jì)說明書文件狀態(tài)：”草稿文件標(biāo)識(shí)：當(dāng)前版本：1.0正式發(fā)布正在修改作 者：完成日期：版本歷史版本/狀態(tài)作者參與者起止日期備注1.0開始編寫修改記錄目錄 TOC o 1-5 h z HYPERLINK l bookmark62 o Current Document 引言5 HYPERLINK l bookmark65 o Current Document 編寫目的5 HYPERLINK l bookmark68 o Current Document 背景5 HYPERLINK l bookmark74 o Current Document 參考資料5 HYPERLINK l

2、bookmark77 o Current Document 術(shù)語(yǔ)定義及說明 5 HYPERLINK l bookmark80 o Current Document 設(shè)計(jì)概述5 HYPERLINK l bookmark84 o Current Document 任務(wù)和目標(biāo)5 HYPERLINK l bookmark87 o Current Document 需求概述5運(yùn)行環(huán)境概述5 HYPERLINK l bookmark90 o Current Document 條件與限制 6詳細(xì)設(shè)計(jì)方法和工具6 HYPERLINK l bookmark93 o Current Document 系統(tǒng)詳細(xì)需求

3、分析6 HYPERLINK l bookmark97 o Current Document 詳細(xì)需求分析6 HYPERLINK l bookmark100 o Current Document 詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析接口需求分析6 HYPERLINK l bookmark103 o Current Document 總體方案確認(rèn)6 HYPERLINK l bookmark107 o Current Document 系統(tǒng)總體結(jié)構(gòu)確認(rèn)6 HYPERLINK l bookmark114 o Current Document 系統(tǒng)詳細(xì)界面劃分7 HYPERLINK l bookmark117

4、 o Current Document 應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細(xì)界面劃分 7 HYPERLINK l bookmark120 o Current Document 系統(tǒng)內(nèi)部詳細(xì)界面劃分7 HYPERLINK l bookmark123 o Current Document 系統(tǒng)詳細(xì)設(shè)計(jì)7 HYPERLINK l bookmark127 o Current Document 系統(tǒng)程序代碼架構(gòu)設(shè)計(jì)7UI(User Interface)用戶界面表示層 7 HYPERLINK l bookmark130 o Current Document BLL(Business Logic Layer)業(yè)務(wù)邏輯層

5、 8 HYPERLINK l bookmark134 o Current Document DAL(Data Access Layer)數(shù)據(jù)訪問層 8 HYPERLINK l bookmark138 o Current Document Common 類庫(kù) 8 HYPERLINK l bookmark142 o Current Document Entity Class 實(shí)體類8 HYPERLINK l bookmark146 o Current Document 系統(tǒng)結(jié)構(gòu)設(shè)計(jì)及子系統(tǒng)劃分8 HYPERLINK l bookmark149 o Current Document 系統(tǒng)功能模塊詳細(xì)

6、設(shè)計(jì)9XX子系統(tǒng)9.1 XX模塊9列表和分頁(yè)9創(chuàng)建XX 9.2 XX模塊9XX列表9XX修改9XX子系統(tǒng)9 HYPERLINK l bookmark154 o Current Document 用戶管理模塊9角色管理模塊14系統(tǒng)設(shè)置模塊14系統(tǒng)登錄注銷模塊14 HYPERLINK l bookmark231 o Current Document 系統(tǒng)界面詳細(xì)設(shè)計(jì)14外部界面設(shè)計(jì)14內(nèi)部界面設(shè)計(jì)14用戶界面設(shè)計(jì)14 HYPERLINK l bookmark234 o Current Document 數(shù)據(jù)庫(kù)系統(tǒng)設(shè)計(jì)14 HYPERLINK l bookmark238 o Current Docu

7、ment 設(shè)計(jì)要求14 HYPERLINK l bookmark242 o Current Document 信息模型設(shè)計(jì)14 HYPERLINK l bookmark246 o Current Document 數(shù)據(jù)庫(kù)設(shè)計(jì)146.3.1 設(shè)計(jì)依據(jù)14數(shù)據(jù)庫(kù)種類及特點(diǎn)15數(shù)據(jù)庫(kù)邏輯結(jié)構(gòu)15物理結(jié)構(gòu)設(shè)計(jì)15數(shù)據(jù)庫(kù)安全15數(shù)據(jù)字典 15 HYPERLINK l bookmark250 o Current Document 信息編碼設(shè)計(jì)15 HYPERLINK l bookmark254 o Current Document 代碼結(jié)構(gòu)設(shè)計(jì)15 HYPERLINK l bookmark258 o Cu

8、rrent Document 代碼編制151 引言1.1編寫目的說明編寫詳細(xì)設(shè)計(jì)方案的主要目的。說明書編制的目的是說明一個(gè)軟件系統(tǒng)各個(gè)層次中的每個(gè)程序（每個(gè)模塊或子程序）和數(shù)據(jù)庫(kù) 系統(tǒng)的設(shè)計(jì)考慮，為程序員編碼提供依據(jù)。如果一個(gè)軟件系統(tǒng)比較簡(jiǎn)單，層次很少，本文件可以不單獨(dú)編寫，和概要設(shè)計(jì)說明書中不重復(fù) 部分合并編寫。方案重點(diǎn)是模塊的執(zhí)行流程和數(shù)據(jù)庫(kù)系統(tǒng)詳細(xì)設(shè)計(jì)的描述。1.2背景應(yīng)包含以下幾個(gè)方面的內(nèi)容：待開發(fā)軟件系統(tǒng)名稱；該系統(tǒng)基本概念，如該系統(tǒng)的類型、從屬地位等；開發(fā)項(xiàng)目組名稱。1.3參考資料列出詳細(xì)設(shè)計(jì)報(bào)告引用的文獻(xiàn)或資料，資料的作者、標(biāo)題、出版單位和出版日期等信息，必 要時(shí)說明如何得到這些

9、資料。1.4術(shù)語(yǔ)定義及說明列出本文檔中用到的可能會(huì)引起混淆的專門術(shù)語(yǔ)、定義和縮寫詞的原文。設(shè)計(jì)概述2.1任務(wù)和目標(biāo)說明詳細(xì)設(shè)計(jì)的任務(wù)及詳細(xì)設(shè)計(jì)所要達(dá)到的目標(biāo)需求概述對(duì)所開發(fā)軟件的概要描述包括主要的業(yè)務(wù)需求、輸入、輸出、主要功能、性能等，尤其需要描述系統(tǒng)性能需求運(yùn)行環(huán)境概述對(duì)本系統(tǒng)所依賴于運(yùn)行的硬件，包括操作系統(tǒng)、數(shù)據(jù)庫(kù)系統(tǒng)、中間件、接口軟件、可能的性 能監(jiān)控與分析等軟件環(huán)境的描述，及配置要求。條件與限制詳細(xì)描述系統(tǒng)所受的內(nèi)部和外部條件的約束和限制說明括業(yè)務(wù)和技術(shù)方面的條件與限制 以及進(jìn)度、管理等方面的限制。詳細(xì)設(shè)計(jì)方法和工具簡(jiǎn)要說明詳細(xì)設(shè)計(jì)所采用的方法和使用的工具。掰O圖方法、IDEF（I2D

10、EF）方法、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ì)的分析。3.1詳細(xì)需求分析包括：詳細(xì)功能需求分析詳細(xì)性能需求分析詳細(xì)資源需求分析詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析3.2詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析接口需求分析包括： 系統(tǒng)接口需求分析現(xiàn)有硬、軟件資源接口需求分析引進(jìn)硬、軟件資源接口需求分析總體方案確認(rèn)著重解決系統(tǒng)總體結(jié)構(gòu)確認(rèn)及界面劃分問題。4.1系統(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í)

11、現(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)4.2系統(tǒng)詳細(xì)界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細(xì)界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)之間的界面包括系統(tǒng)主服務(wù)器與其他服務(wù)器的服務(wù)范圍及訪問方式，網(wǎng)絡(luò) 及數(shù)據(jù)庫(kù)對(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ì)5.1系統(tǒng)程序代碼架構(gòu)設(shè)計(jì)系統(tǒng)采用三層架構(gòu)模型，將應(yīng)用系統(tǒng)

12、劃分為用戶界面表示層、業(yè)務(wù)邏輯層、數(shù)據(jù)訪問層，以及Entity Class實(shí)體類、Common類庫(kù)組成，各層的關(guān)系如下圖所示：5.1.1 UI(User Interface)用戶界面表示層負(fù)責(zé)與用戶進(jìn)行交互，顯示、接受數(shù)據(jù)，與此同時(shí)，做一些簡(jiǎn)單邏輯處理，如：輸入數(shù)據(jù)有效 性判斷、顯示各種異常、處理Dataset記錄集數(shù)據(jù)。它只與BLL(Business Logic Layer)業(yè)務(wù)邏輯層、 Entity Class實(shí)體類兩個(gè)項(xiàng)目發(fā)生關(guān)聯(lián)，可能與Common類庫(kù)發(fā)生.關(guān)聯(lián)。BLL(Business Logic Layer)業(yè)務(wù)邏輯層是整個(gè)系統(tǒng)的核心，它承擔(dān)了所有的邏輯判斷，實(shí)現(xiàn)了程序的功能，它是

13、靈活的。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類庫(kù)。雖然BLL層被。層調(diào)用，但是BLL層無需關(guān)心UI層的情況。數(shù)據(jù)庫(kù)中每個(gè)表都 對(duì)應(yīng)一個(gè)BLL類，為了達(dá)到解耦效果，BLL類不能直接調(diào)用其他表的DAL類，可以BLL類之間相互調(diào)用。DAL(Data Access Layer)數(shù)據(jù)訪問層提供數(shù)據(jù)訪問的接口，沒有任何邏輯。在接口中對(duì)數(shù)據(jù)庫(kù)操作語(yǔ)句進(jìn)行組合裝配。DAL層一般 關(guān)聯(lián) Common類庫(kù)中的最底層，最基礎(chǔ)的數(shù)據(jù)庫(kù)類(比如：鏈接數(shù)據(jù)庫(kù))，必須關(guān)聯(lián)Entity Class實(shí) 體類項(xiàng)目。DAL層只是數(shù)據(jù)庫(kù)的管理

14、者，但不是訪問者，不直接與數(shù)據(jù)庫(kù)發(fā)生關(guān)聯(lián)。數(shù)據(jù)庫(kù)中每個(gè) 表都對(duì)應(yīng)一個(gè)DAL層的接口(訪問控制)類。Common類庫(kù)用于存放公用的類。最常用的就是數(shù)據(jù)庫(kù)訪問類，比如：鏈接字符串，數(shù)據(jù)庫(kù)引擎類。它直接 與數(shù)據(jù)庫(kù)進(jìn)行機(jī)械式的交換，無任何邏輯。Entity Class實(shí)體類相當(dāng)于加強(qiáng)的數(shù)據(jù)結(jié)構(gòu)，實(shí)現(xiàn)了對(duì)數(shù)據(jù)的封裝。數(shù)據(jù)庫(kù)中每個(gè)表都對(duì)應(yīng)一個(gè)實(shí)體類，表的字段 就是實(shí)體類的屬性，類型一一對(duì)應(yīng)。UI、BLL、DAL這三層的交互主要就是通過實(shí)體類作為參數(shù)，并 Return回信息。5.2系統(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)，如下圖所示：各個(gè)子系統(tǒng)按照功能角

15、度分解，劃分出若干不同的功能模塊，如下面各圖所示:5.3系統(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)系和信息交3SIPO 圖或其他方法描述各模塊完成的功能。以上建議采期ipo圖進(jìn)行功能分解與模塊描述，更高的要 求建議采用IDEF（方法進(jìn)行功能模型設(shè)計(jì)。詳細(xì)設(shè)計(jì)應(yīng)用系統(tǒng)的各個(gè)構(gòu)成模塊完成的功能及其相互之間的關(guān)系，1用或結(jié)構(gòu)圖描述各 模塊的組成結(jié)構(gòu)、算法、模塊間的接口關(guān)系，以及需求、功能和模塊三者之間的交叉參照關(guān)系。每個(gè)模塊的描述說明可參照以下格式：模塊

16、編號(hào)：模塊名稱：輸入：處理：算法描述：輸出：其中處理和算法描述部分主要采用偽碼或具體的程序語(yǔ)言完成。對(duì)詳細(xì)設(shè)計(jì)更高的要求建議用DEF0圖進(jìn)行各功能模塊的設(shè)計(jì)。如果對(duì)軟件需進(jìn)行二次開發(fā)（包括功能擴(kuò)展、功能改造、用戶界面改造等），則相應(yīng)的設(shè)計(jì)工 作應(yīng)該設(shè)立子課題完成。注意：算法描述主要是說明BLL層的代碼邏輯，UI層只做簡(jiǎn)單的輸入驗(yàn)證和界面顯示功能。XX子系統(tǒng).1 XX模塊列表和分頁(yè)創(chuàng)建XX.2 XX模塊XX列表XX修改XX子系統(tǒng)5.3.6.1 用戶管理模塊模塊描述：管理系統(tǒng)用戶，包括添加用戶并賦予角色、修改用戶資料和角色、刪除用戶。主要功能：添加用戶、修改用戶、刪除用戶、列表和分頁(yè)。5.3.6.

17、1.1 列表和分頁(yè)1、流程圖省略2、輸入項(xiàng)分頁(yè)索引頁(yè)面?zhèn)鲄?shù)頁(yè)面加載時(shí)為13、輸出項(xiàng)1）列表詳細(xì)記錄；2）當(dāng)前頁(yè)碼；3）分頁(yè)總數(shù)；4）記錄總數(shù)。4、算法描述系統(tǒng)管理用戶數(shù)據(jù)量不大，而且該功能使用頻率不高，可以不用優(yōu)化分頁(yè)，直接獲取用戶表全 部記錄，建議UI層使用gridview控件，調(diào)用ExamSys.BLL. System_admin_info GetAllList（）綁定控件，利 用gridview自帶分頁(yè)功能，顯示分頁(yè)按鈕、當(dāng)前頁(yè)、分頁(yè)總數(shù)、記錄總數(shù)、添加用戶1、流程圖2、輸入項(xiàng)用戶IDstring必填姓名string必填用戶密碼string必填確認(rèn)密碼string必填聯(lián)系電話strin

18、gE-mailstring狀態(tài)char用戶角色I(xiàn)Dstring3、輸出項(xiàng)1）成功，UI提示添加用戶完成；2）失敗，UI提示具體信息。4、算法描述1）前端js判斷必填項(xiàng)的輸入和二次密碼是否相同，角色可以不選;BLL須驗(yàn)證必填項(xiàng)，用戶名是唯一的不能重復(fù)；加密密碼使用MD5.Encrypt(string String, string Key), Key = XXXXXXXX；用戶 信息保 存至表 System_admin_info， ExamSys.DAL. System_admin_infoAdd(ExamSys.Model.System_admin_info model)；分拆角色I(xiàn)D字符串并循

19、環(huán)字符串?dāng)?shù)組，信息保存至表Dict_admin_vs_roles，ExamSys.BLL. Dict_admin_vs_roles Add(ExamSys.Model.Dict_admin_vs_roles model)。修改用戶1、流程圖2、輸入項(xiàng)用戶IDstring頁(yè)面?zhèn)鲄?shù)姓名string必填用戶密碼string必填確認(rèn)密碼string必填聯(lián)系電話stringE-mailstring狀態(tài)char用戶角色I(xiàn)Dstring3、輸出項(xiàng)成功，UI提示修改用戶完成；失敗，UI提示具體信息。4、算法描述前端js判斷必填項(xiàng)的輸入和二次密碼是否相同，角色可以不選；LinLiYan；admin_vs_ro

20、lesadmin_vs_roles加密密碼使用Chukeh.Security. MD5. Encrypt(string String, string LinLiYan；admin_vs_rolesadmin_vs_roles根據(jù)用戶 ID 刪除表 Dict_admin_vs_roles 的記錄 ExamSys.BLL. DictDeleteByAdminID(string admin_id)；分拆角色I(xiàn)D字符串并循環(huán)字符串?dāng)?shù)組，信息保存至該表ExamSys.BLL. DictAdd(ExamSys.Model. Dict_admin_vs_roles model)。刪除用戶1、流程圖2、輸入項(xiàng)

21、用戶IDstring頁(yè)面?zhèn)鲄?shù)3、輸出項(xiàng)1、成功，UI提示刪除用戶完成，刷新列表;2、失敗，UI提示具體信息。3、算法描述1）根據(jù)用戶【D刪除表 System_admin_info的記錄 ExamSys.DAL. System_admin_info Delete（string admin_id）；2）根據(jù)用戶 ID 刪除表 Dict_admin_vs_roles 的記錄 ExamSys.BLL. Dict_admin_ vs_roles DeleteByAdminID（string admin_id）。角色管理模塊系統(tǒng)設(shè)置模塊系統(tǒng)登錄注銷模塊5.4系統(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)部各功能模塊間