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

1、Forpersonaluseonlyinstudyandresearch;notforc0mmercialuse薇節(jié)螃腿噩建xxxxx系統(tǒng)期詳細(xì)設(shè)計(jì)說明書衿莆文件狀態(tài)：裊文件標(biāo)蒙識:螃，草稿蔽正式發(fā)布贛止在修改原當(dāng)前版本：先1.0蓬作者：曹肄完成日期：市苗版本歷史蛔芳版本/狀態(tài)量作者蟆參與者案起止日期筮備注肇1.0芨耳市盆開始編寫蛔月退蝸-+-幾蜘膂前聿腿n膀腿修改記錄蝸童日期賺修訂版本德修改章節(jié)肆修改描述募作者節(jié)妍要膈聿衿袈建蔽肆羈芨襖蒲筮聿蝕5.1.4Common庫 錯(cuò)誤！未定義書簽。目錄神1弓I百錯(cuò)誤！未定義書簽。衿1.1編寫目的錯(cuò)誤！未定義書簽。熊1.2背景錯(cuò)誤！未定義書簽。肄1.3參

2、考資料錯(cuò)誤！未定義書簽。方1.4術(shù)語定義及說明錯(cuò)誤！未定義書簽。期2設(shè)計(jì)概述錯(cuò)誤！未定義書簽。蝴2.1任務(wù)和目標(biāo)錯(cuò)誤！未定義書簽。膂2.1.1需求概述錯(cuò)誤！未定義書簽。第2.1.2運(yùn)行環(huán)境概述錯(cuò)誤！未定義書簽。肆2.1.3條件與限制錯(cuò)誤！未定義書簽。裊2.1.4詳細(xì)設(shè)計(jì)方法和工具錯(cuò)誤！未定義書簽。黃3系統(tǒng)詳細(xì)需求分析錯(cuò)誤！未定義書簽。肇3.1詳細(xì)需求分析錯(cuò)誤！未定義書簽。蟆3.2詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析接口需求分析錯(cuò)誤！未定義書簽。噩4總體方案確認(rèn)錯(cuò)誤！未定義書簽。蜜4.1系統(tǒng)總體結(jié)構(gòu)確認(rèn)錯(cuò)誤！未定義書簽。螂4.2系統(tǒng)詳細(xì)界面劃分錯(cuò)誤！未定義書簽。薇4.2.1應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細(xì)界面

3、劃分錯(cuò)誤！未定義書簽。端4.2.2系統(tǒng)內(nèi)部詳細(xì)界面劃分錯(cuò)誤！未定義書簽。腿5系統(tǒng)詳細(xì)設(shè)計(jì)錯(cuò)誤！未定義書簽。范5.1系統(tǒng)程序代碼架構(gòu)設(shè)計(jì)錯(cuò)誤！未定義書簽。芾5.1.1UI(UserInterface)用戶界面表示層錯(cuò)誤！未定義書簽。嵋5.1.2BLL(BusinessLogicLayer)業(yè)務(wù)邏輯層錯(cuò)誤！未定義書簽。月15.1.3DAL(DataAccessLayer)數(shù)據(jù)訪問層錯(cuò)誤！未定義書簽。肇5.1.5EntityClass實(shí)體類錯(cuò)誤！未定義書簽。W5.2系統(tǒng)結(jié)構(gòu)設(shè)計(jì)及子系統(tǒng)劃分錯(cuò)誤！未定義書簽。節(jié)5.3系統(tǒng)功能模塊詳細(xì)設(shè)計(jì)錯(cuò)誤！未定義書簽。聿5.3.1XXF系統(tǒng)錯(cuò)誤！未定義書簽。蝌1XX

4、塊錯(cuò)誤！未定義書簽。蚄列表和分頁錯(cuò)誤！未定義書簽。薄創(chuàng)建XX錯(cuò)誤！未定義書簽。菌.2XXB塊錯(cuò)誤！未定義書簽。曹X*U表錯(cuò)誤！未定義書簽。蛔XX啰改錯(cuò)誤！未定義書簽。螃5.3.2XXF系統(tǒng)錯(cuò)誤！未定義書簽。量用戶管理模塊錯(cuò)誤！未定義書簽。艿角色管理模塊錯(cuò)誤！未定義書簽。蟆系統(tǒng)設(shè)置模塊錯(cuò)誤！未定義書簽。袁系統(tǒng)登錄注銷模塊錯(cuò)誤！未定義書簽。螞5.4系統(tǒng)界面詳細(xì)設(shè)計(jì)錯(cuò)誤！未定義書簽。量5.4.1外部界面設(shè)計(jì)錯(cuò)誤！未定義書簽。薄5.4.2內(nèi)部界面設(shè)計(jì)錯(cuò)誤！未定義書簽。艘5.4.3用戶界面設(shè)計(jì)錯(cuò)誤！未定義書簽。犀6數(shù)據(jù)庫系統(tǒng)設(shè)計(jì)錯(cuò)誤！未定義書簽。蠅6.1設(shè)計(jì)要求錯(cuò)誤！未定義書簽。薅6.2信息模型設(shè)計(jì)錯(cuò)誤

5、！未定義書簽。前6.3數(shù)據(jù)庫設(shè)計(jì)錯(cuò)誤！未定義書簽。蓬6.3.1設(shè)計(jì)依據(jù)錯(cuò)誤！未定義書簽。滕6.3.2數(shù)據(jù)庫種類及特點(diǎn)錯(cuò)誤！未定義書簽。蟻6.3.3數(shù)據(jù)庫邏輯結(jié)構(gòu)錯(cuò)誤！未定義書簽。妨6.3.4物理結(jié)構(gòu)設(shè)計(jì)錯(cuò)誤！未定義書簽。未勺6.3.5數(shù)據(jù)庫安全錯(cuò)誤！未定義書簽。噩6.3.6數(shù)據(jù)字典錯(cuò)誤！未定義書簽。蔻7信息編碼設(shè)計(jì)錯(cuò)誤！未定義書簽。螃7.1代碼結(jié)構(gòu)設(shè)計(jì)錯(cuò)誤！未定義書簽。箴7.2代碼編制錯(cuò)誤！未定義書簽。12 期引百2.12.2 菱編寫目的羈說明編寫詳細(xì)設(shè)計(jì)方案的主要目的。蠅說明書編制的目的是說明一個(gè)軟件系統(tǒng)各個(gè)層次中的每個(gè)程序（每個(gè)模塊或子程序）和數(shù)據(jù)庫系統(tǒng)的設(shè)計(jì)考慮，為程序員編碼提供依據(jù)。藏

6、如果一個(gè)軟件系統(tǒng)比較簡單，層次很少，本文件可以不單獨(dú)編寫，和概要設(shè)計(jì)說明書中不重復(fù)部分合并編寫。薇方案重點(diǎn)是模塊的執(zhí)行流程和數(shù)據(jù)庫系統(tǒng)詳細(xì)設(shè)計(jì)的描述。2.32.4 荒背景膈應(yīng)包含以下幾個(gè)方面的內(nèi)容：胭A.待開發(fā)軟件系統(tǒng)名稱；童B.該系統(tǒng)基本概念，如該系統(tǒng)的類型、從屬地位等；前C.開發(fā)項(xiàng)目組名稱2.52.6 袂參考資料贛列出詳細(xì)設(shè)計(jì)報(bào)告引用的文獻(xiàn)或資料，資料的作者、標(biāo)題、出版單位和出版日期等信息，必要時(shí)說明如何得到這些資料。2.72.8 荽術(shù)語定義及說明蝴列出本文檔中用到的可能會引起混淆的專門術(shù)語、定義和縮寫詞的原文。34 尢設(shè)計(jì)概述4.14.2 妍任務(wù)和目標(biāo)芃說明詳細(xì)設(shè)計(jì)的任務(wù)及詳細(xì)設(shè)計(jì)所要達(dá)

7、到的目標(biāo)。4.2.14.2.2 褻需求概述蜜對所開發(fā)軟件的概要描述，包括主要的業(yè)務(wù)需求、輸入、輸出、主要功能、性能等，尤其需要描述系統(tǒng)性能需求。4.2.34.2.4 蒈運(yùn)行環(huán)境概述芄對本系統(tǒng)所依賴于運(yùn)行的硬件，包括操作系統(tǒng)、數(shù)據(jù)庫系統(tǒng)、中間件、接口軟件、可能的性能監(jiān)控與分析等軟件環(huán)境的描述，及配置要求。4.2.54.2.6 羈條件與限制膀詳細(xì)描述系統(tǒng)所受的內(nèi)部和外部條件的約束和限制說明。包括業(yè)務(wù)和技術(shù)方面的條件與限制以及進(jìn)度、管理等方面的限制。4.2.74.2.8 腿詳細(xì)設(shè)計(jì)方法和工具莆簡要說明詳細(xì)設(shè)計(jì)所采用的方法和使用的工具。如HIPC方法、IDEF(I2DEF)方法、E幽，數(shù)據(jù)流程圖、業(yè)務(wù)

8、流程圖、選用的CASE：具等，盡量采用標(biāo)準(zhǔn)規(guī)范和輔助工具。56蒂系統(tǒng)詳細(xì)需求分析覆主要對系統(tǒng)級的需求進(jìn)行分析。首先應(yīng)對需求分析提出的企業(yè)需求進(jìn)一步確認(rèn)，并對由于情況變化而帶來的需求變化進(jìn)行較為詳細(xì)的分析。6.16.2 衿詳細(xì)需求分析膈包括： 蒂詳細(xì)功能需求分析 肇詳細(xì)性能需求分析 蠶詳細(xì)資源需求分析,瞧詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析6.36.4 襖詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析接口需求分析螞包括：滕系統(tǒng)接口需求分析黃現(xiàn)有硬、軟件資源接口需求分析輻引進(jìn)硬、軟件資源接口需求分析8 賺總體方案確認(rèn)祎著重解決系統(tǒng)總體結(jié)構(gòu)確認(rèn)及界面劃分問題。8.18.2 肅系統(tǒng)總體結(jié)構(gòu)確認(rèn)康對系統(tǒng)組成、邏輯結(jié)構(gòu)及層次進(jìn)

9、行確認(rèn)，對應(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)8.38.4 滕系統(tǒng)詳細(xì)界面劃分8.4.18.4.2 蕨應(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ù)的管理與存取方式等。8.4.38.4.4 肇系統(tǒng)內(nèi)部詳細(xì)界面劃分籍系統(tǒng)各功能之間的界面包括覆蓋范圍，模塊間功能調(diào)用涉及到的系統(tǒng)模塊及方法，

10、全局?jǐn)?shù)據(jù)格式，系統(tǒng)性能要求等。910箍系統(tǒng)詳細(xì)設(shè)計(jì)10.110.2衿系統(tǒng)程序代碼架構(gòu)設(shè)計(jì)袈系統(tǒng)采用三層架構(gòu)模型，將應(yīng)用系統(tǒng)劃分為用戶界面表示層、業(yè)務(wù)邏輯層、數(shù)據(jù)訪問層，以及EntityClass實(shí)體類、Common庫組成，各層的關(guān)系如下圖所示：10.2.110.2.2 建UI(UserInterface)用戶界面表示層蔽負(fù)責(zé)與用戶進(jìn)行交互，顯示、接受數(shù)據(jù)，與此同時(shí)，做一些簡單邏輯處理，如：輸入數(shù)據(jù)有效性判斷、顯示各種異常、處理Dataset記錄集數(shù)據(jù)。它只與BLL(BusinessLogicLayer)業(yè)務(wù)邏輯層、EntityClass實(shí)體類兩個(gè)項(xiàng)目發(fā)生關(guān)聯(lián)，可能與Common庫發(fā)生關(guān)聯(lián)。10

11、.2.310.2.4 菅BLL(BusinessLogicLayer)業(yè)務(wù)邏輯層肆是整個(gè)系統(tǒng)的核心，它承擔(dān)了所有的邏輯判斷，實(shí)現(xiàn)了程序的功能，它是靈活的。BLL層既是調(diào)用者，又是被調(diào)用者，因此，要適當(dāng)?shù)倪M(jìn)行設(shè)計(jì)達(dá)到解耦的效果。BLLM只關(guān)聯(lián)DALM和實(shí)體類，可能關(guān)聯(lián)Common1庫。雖然BLLM被U層調(diào)用，但是BLL層無需關(guān)心UI層的情況。數(shù)據(jù)庫中每個(gè)表都對應(yīng)一個(gè)BLL類，為了達(dá)到解耦效果，BLL類不能直接調(diào)用其他表的DAia,可以BL塊之間相互調(diào)用。10.2.510.2.6 賺DAL(DataAccessLayer)數(shù)據(jù)訪問層羈提供數(shù)據(jù)訪問的接口，沒有任何邏輯。在接口中對數(shù)據(jù)庫操作語句進(jìn)行組

12、合裝配。DALB一般關(guān)聯(lián)Common庫中的最底層，最基礎(chǔ)的數(shù)據(jù)庫類(比如：鏈接數(shù)據(jù)庫)，必須關(guān)聯(lián)EntityClass實(shí)體類項(xiàng)目。DALB只是數(shù)據(jù)庫的管理者，但不是訪問者，不直接與數(shù)據(jù)庫發(fā)生關(guān)聯(lián)。數(shù)據(jù)庫中每個(gè)表都對應(yīng)一個(gè)DALM的接口(訪問控制)類。10.2.710.2.8 裴Common庫襖用于存放公用的類。最常用的就是數(shù)據(jù)庫訪問類，比如：鏈接字符串，數(shù)據(jù)庫引擎類。它直接與數(shù)據(jù)庫進(jìn)行機(jī)械式的交換，無任何邏輯。10.2.910.2.10 WEntityClass實(shí)體類筮相當(dāng)于加強(qiáng)的數(shù)據(jù)結(jié)構(gòu)，實(shí)現(xiàn)了對數(shù)據(jù)的封裝。數(shù)據(jù)庫中每個(gè)表都對應(yīng)一個(gè)實(shí)體類，表的字段就是實(shí)體類的屬性，類型一一對應(yīng)。UI、BLL

13、、DAE三層的交互主要就是通過實(shí)體類作為參數(shù),并Return回信息。10.310.4 聿系統(tǒng)結(jié)構(gòu)設(shè)計(jì)及子系統(tǒng)劃分箍根據(jù)業(yè)務(wù)和功能，將系統(tǒng)的邏輯結(jié)構(gòu)劃分為XX?系統(tǒng)、XXF系等6個(gè)子系統(tǒng)，如下圖所示:蟆各個(gè)子系統(tǒng)按照功能角度分解，劃分出若干不同的功能模塊，如下面各圖所示:噩蜜螂薇10.510.6 腿系統(tǒng)功能模塊詳細(xì)設(shè)計(jì)范按結(jié)構(gòu)化設(shè)計(jì)方法，在系統(tǒng)功能逐層分解的基礎(chǔ)上，對系統(tǒng)各功能模塊或子系統(tǒng)進(jìn)行設(shè)計(jì)。此為詳細(xì)設(shè)計(jì)的主要部分之一。芾用層次圖描述系統(tǒng)的總體結(jié)構(gòu)、功能分解及各個(gè)模塊之間的相互調(diào)用關(guān)系和信息交互，用IPO圖或其他方法描述各模塊完成的功能。以上建議采用HIPCS進(jìn)行功能分解與模塊描述，更高的

14、要求建議采用IDEF昉法進(jìn)行功能模型設(shè)計(jì)。嵋詳細(xì)設(shè)計(jì)應(yīng)用系統(tǒng)的各個(gè)構(gòu)成模塊完成的功能及其相互之間的關(guān)系，用IPC或結(jié)構(gòu)圖描述各模塊的組成結(jié)構(gòu)、算法、模塊間的接口關(guān)系，以及需求、功能和模塊三者之間的交叉參照關(guān)系。艘每個(gè)模塊的描述說明可參照以下格式:蝕模塊編號：肇模塊名稱：初輸入：節(jié)處理：聿算法描述：螈輸出：蚄其中處理和算法描述部分主要采用偽碼或具體的程序語言完成。薄對詳細(xì)設(shè)計(jì)更高的要求建議用IDEF01進(jìn)行各功能模塊的設(shè)計(jì)。唐如果對軟件需進(jìn)行二次開發(fā)（包括功能擴(kuò)展、功能改造、用戶界面改造等），則相應(yīng)的設(shè)計(jì)工作應(yīng)該設(shè)立子課題完成。蒈蛔注意：算法描述主要是說明BLLM的代碼邏輯，UI層只做簡單的輸入

15、驗(yàn)證和界面顯示功能。螃10.6.110.6.2 量XXf系統(tǒng).1.2芳XXg塊蟆列表和分頁袁創(chuàng)建XX.3.4螞XXg塊量X*U表薄XX啰改10.6.310.6.4 月nXXf系統(tǒng)5.3.6.15.3.6.2 犀用戶管理模塊蠅模塊描述：管理系統(tǒng)用戶，包括添加用戶并賦予角色、修改用戶資料和角色、刪除用戶。薅主要功能：添加用戶、修改用戶、刪除用戶、列表和分頁。5.3.6.1.15.3.6.3 .2前列表和分頁1、2、蓬流程圖滕省略3、4、蟻輸入項(xiàng)蚄分頁索引頁面?zhèn)鲄?shù)頁面加載時(shí)為15、6、木勺輸出項(xiàng)1)2)噩列表詳細(xì)記錄；3)4) 蒄當(dāng)前頁碼；5)6) 螃分頁總數(shù)；7)8)箴記錄總數(shù)。8)9) 蚆算法

16、描述菱系統(tǒng)管理用戶數(shù)據(jù)量不大，而且該功能使用頻率不高，可以不用優(yōu)化分頁，直接獲取用戶表全部記錄，建議UI層使用gridview控件，調(diào)用GetAllList()綁定控件，禾U用gridview自帶分頁功能,顯示分頁按鈕、當(dāng)前頁、分頁總數(shù)、記錄總數(shù)、5.3.6.1.35.3.6.1.4羈添加用戶1、2、蠅流程圖3、4、蒂輸入項(xiàng)覆用戶IDstring必填衿姓名string必填膈用戶密碼string必填肇聯(lián)系電話string蠶E-mailstring腦狀態(tài)char襖用戶角色I(xiàn)Dstring5、6、 螞輸出項(xiàng)1)2)滕成功，UI提示添加用戶完成；3)4)黃失敗，UI提示具體信息。7、8、精算法描述1)

17、2)賺前端js判斷必填項(xiàng)的輸入和二次密碼是否相同，角色可以不選；3)4)未811驗(yàn)證必填項(xiàng)，用戶名是唯一的不能重復(fù)；5)6) 肅加密密碼使用MD5.Encrypt(stringString,stringKey)，Key=XXXXXXXX；7)8)犀用戶信息保存至表System_admin_info,Add(model)；9)10)莫分拆角色I(xiàn)D字符串并循環(huán)字符串?dāng)?shù)組，信息保存至表Dict_admin_vs_roles,Add(model)。5.3.6.1.55.3.6.1.6 蚆修改用戶1、2、瞧流程圖3、4、聿輸入項(xiàng)箍用戶IDstring頁面?zhèn)鲄?shù)蟻姓名string必填何用戶密碼string

18、必填衿確認(rèn)密碼string必填黑聯(lián)系電話stringstring肄E-mail方狀態(tài)char薄用戶角色I(xiàn)Dstring5、6、蝴輸出項(xiàng)1)2)膂成功，UI提示修改用戶完成；3、4)蠶失敗，UI提示具體信息。7、8、 肆算法描述1)2) 裊前端js判斷必填項(xiàng)的輸入和二次密碼是否相同，角色可以不選；3)4)范加密密碼使用Encrypt(stringString,stringKey),Key=LinLiYan；5)6) 肇根據(jù)用戶ID刪除表Dict_admin_vs_roles的記錄DeleteByAdminID(stringadmin_id)；7)8)蜜分拆角色I(xiàn)D字符串并循環(huán)字符串?dāng)?shù)組，信息保存

19、至該表Add(model)。5.3.6.1.75.3.6.1.8 就刪除用戶1、2、 薇流程圖嵋3、輸入項(xiàng)用戶IDstring頁面?zhèn)鲄?shù)4、輸出項(xiàng)1、成功，UI提示刪除用戶完成，刷新列表；2、失敗，UI提示具體信息。3、算法描述1）根據(jù)用戶ID刪除表System_admin_info的記錄Delete（stringadmin_id）；2）根據(jù)用戶ID刪除表Dict_admin_vs_roles的記錄DeleteByAdminID（stringadmin_id）。5.3.6.3 角色管理模塊5.3.6.4 系統(tǒng)設(shè)置模塊5.3.6.5 系統(tǒng)登錄注銷模塊10.7系統(tǒng)界面詳細(xì)設(shè)計(jì)系統(tǒng)界面說明應(yīng)用系統(tǒng)軟件的各種接口。整個(gè)系統(tǒng)的其他接口（如系統(tǒng)硬件接口、通訊接口等）在相應(yīng)的部分說明。10.7.1 外部界面設(shè)計(jì)根據(jù)系統(tǒng)界面劃分進(jìn)行系統(tǒng)外部界面設(shè)計(jì)，對系統(tǒng)的所有外部接口（包括功能和數(shù)據(jù)接口）進(jìn)行設(shè)計(jì)10.7.2 內(nèi)部界面設(shè)計(jì)設(shè)計(jì)系統(tǒng)內(nèi)部各功能模塊間的調(diào)用關(guān)系和數(shù)據(jù)接口。10.7.3 用戶界面設(shè)計(jì)規(guī)定人機(jī)界面的內(nèi)容、界面風(fēng)格、調(diào)用方式等，包括所謂的表單設(shè)計(jì)、報(bào)表設(shè)計(jì)和用戶需要的打印輸出等設(shè)計(jì)。此部分內(nèi)容可能比較多。11 數(shù)據(jù)庫系統(tǒng)設(shè)計(jì)此數(shù)據(jù)庫設(shè)計(jì)可單獨(dú)成冊，尤其對大型的數(shù)據(jù)庫應(yīng)用系統(tǒng)，即有一個(gè)單獨(dú)的