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

xxxxx系統(tǒng)詳細(xì)設(shè)計(jì)說(shuō)明書(shū)文件狀態(tài)：[V]草稿[]正式發(fā)布[]正在修改文件標(biāo)識(shí)：當(dāng)前版本：1.0完成日期：

版本歷史版本/狀態(tài)作者參與者起止日期備注1.0開(kāi)始編寫(xiě)修改記錄日期修訂版本修改章節(jié)修改描述作者目錄TOC\o"1-5"\h\z弓I言5編寫(xiě)目的5背景5參考資料5術(shù)語(yǔ)定義及說(shuō)明5設(shè)計(jì)概述5任務(wù)和目標(biāo)5需求概述5運(yùn)行環(huán)境概述5條件與限制6詳細(xì)設(shè)計(jì)方法和工具6系統(tǒng)詳細(xì)需求分析6詳細(xì)需求分析6詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析接口需求分析6總體方案確認(rèn)6系統(tǒng)總體結(jié)構(gòu)確認(rèn)6系統(tǒng)詳細(xì)界面劃分7應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細(xì)界面劃分7系統(tǒng)內(nèi)部詳細(xì)界面劃分7系統(tǒng)詳細(xì)設(shè)計(jì)7系統(tǒng)程序代碼架構(gòu)設(shè)計(jì)7UI(UserInterface)用戶界面表示層7BLL(BusinessLogicLayer)業(yè)務(wù)邏輯層8DAL(DataAccessLayer)數(shù)據(jù)訪問(wèn)層8Common庫(kù)8EntityClass實(shí)體類8系統(tǒng)結(jié)構(gòu)設(shè)計(jì)及子系統(tǒng)劃分8系統(tǒng)功能模塊詳細(xì)設(shè)計(jì)9XXF系統(tǒng)9.1XXH塊9列表和分頁(yè)9創(chuàng)立XX9.2XXH塊9X*U表9XXW改9XXF系統(tǒng)9用戶治理模塊9角色治理模塊14系統(tǒng)設(shè)置模塊14系統(tǒng)登錄注銷模塊14系統(tǒng)界面詳細(xì)設(shè)計(jì)14外部界面設(shè)計(jì)14內(nèi)部界面設(shè)計(jì)14用戶界面設(shè)計(jì)14數(shù)據(jù)庫(kù)系統(tǒng)設(shè)計(jì)14設(shè)計(jì)要求14信息模型設(shè)計(jì)14數(shù)據(jù)庫(kù)設(shè)計(jì)14設(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信息編碼設(shè)計(jì)15代碼結(jié)構(gòu)設(shè)計(jì)15代碼編制15引言編寫(xiě)目的說(shuō)明編寫(xiě)詳細(xì)設(shè)計(jì)方案的主要目的.說(shuō)明書(shū)編制的目的是說(shuō)明一個(gè)軟件系統(tǒng)各個(gè)層次中的每個(gè)程序〔每個(gè)模塊或子程序〕和數(shù)據(jù)庫(kù)系統(tǒng)的設(shè)計(jì)考慮,為程序員編碼提供依據(jù).如果一個(gè)軟件系統(tǒng)比擬簡(jiǎn)單,層次很少,本文件可以不單獨(dú)編寫(xiě),和概要設(shè)計(jì)說(shuō)明書(shū)中不重復(fù)局部合并編寫(xiě).方案重點(diǎn)是模塊的執(zhí)行流程和數(shù)據(jù)庫(kù)系統(tǒng)詳細(xì)設(shè)計(jì)的描述.背景應(yīng)包含以下幾個(gè)方面的內(nèi)容：A.待開(kāi)發(fā)軟件系統(tǒng)名稱；B.該系統(tǒng)根本概念,如該系統(tǒng)的類型、附屬地位等；C.開(kāi)發(fā)工程組名稱.參考資料列出詳細(xì)設(shè)計(jì)報(bào)告引用的文獻(xiàn)或資料,資料的作者、標(biāo)題、出版單位和出版日期等信息,必要時(shí)說(shuō)明如何得到這些資料.術(shù)語(yǔ)定義及說(shuō)明列出本文檔中用到的可能會(huì)引起混淆的專門(mén)術(shù)語(yǔ)、定義和縮寫(xiě)詞的原文.設(shè)計(jì)概述任務(wù)和目標(biāo)說(shuō)明詳細(xì)設(shè)計(jì)的任務(wù)及詳細(xì)設(shè)計(jì)所要到達(dá)的目標(biāo).需求概述對(duì)所開(kāi)發(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)部和外部條件的約束和限制說(shuō)明.包括業(yè)務(wù)和技術(shù)方面的條件與限制以及進(jìn)度、治理等方面的限制.詳細(xì)設(shè)計(jì)方法和工具簡(jiǎn)要說(shuō)明詳細(xì)設(shè)計(jì)所采用的方法和使用的工具.如HIPCS方法、IDEF(I2DEF)方法、E-R圖,數(shù)據(jù)流程圖、業(yè)務(wù)流程圖、選用的CASE：具等,盡量采用標(biāo)準(zhǔn)標(biāo)準(zhǔn)和輔助工具.系統(tǒng)詳細(xì)需求分析主要對(duì)系統(tǒng)級(jí)的需求進(jìn)行分析.首先應(yīng)對(duì)需求分析提出的企業(yè)需求進(jìn)一步確認(rèn),并對(duì)由于情況變化而帶來(lái)的需求變化進(jìn)行較為詳細(xì)的分析.詳細(xì)需求分析包括：?詳細(xì)功能需求分析?詳細(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)及界面劃分問(wè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)之間的界面包括系統(tǒng)主效勞器與其他效勞器的效勞范圍及訪問(wèn)方式,網(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ì)系統(tǒng)程序代碼架構(gòu)設(shè)計(jì)系統(tǒng)采用三層架構(gòu)模型,將應(yīng)用系統(tǒng)劃分為用戶界面表示層、業(yè)務(wù)邏輯層、數(shù)據(jù)訪問(wèn)層,以及EntityClass實(shí)體類、Comm旗庫(kù)組成,各層的關(guān)系如下列圖所示：UI(UserInterface)用戶界面表示層負(fù)責(zé)與用戶進(jìn)行交互,顯示、接受數(shù)據(jù),與此同時(shí),做一些簡(jiǎn)單邏輯處理,如：輸入數(shù)據(jù)有效性判斷、顯示各種異常、處理Dataset記錄集數(shù)據(jù).它只與BLL(BusinessLogicLayer)業(yè)務(wù)邏輯層、EntityClass實(shí)體類兩個(gè)工程發(fā)生關(guān)聯(lián),可能與Common庫(kù)發(fā)生關(guān)聯(lián).BLL(BusinessLogicLayer)業(yè)務(wù)邏輯層是整個(gè)系統(tǒng)的核心,它承當(dāng)了所有的邏輯判斷,實(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)Common庫(kù).雖然BLLM被U層調(diào)用,但是BLL層無(wú)需關(guān)心UI層的情況.數(shù)據(jù)庫(kù)中每個(gè)表都對(duì)應(yīng)一個(gè)BLL類,為了到達(dá)解耦效果,BLL類不能直接調(diào)用其他表的DALI,可以BL塊之間相互調(diào)用.DAL(DataAccessLayer)數(shù)據(jù)訪問(wèn)層提供數(shù)據(jù)訪問(wèn)的接口,沒(méi)有任何邏輯.在接口中對(duì)數(shù)據(jù)庫(kù)操作語(yǔ)句進(jìn)行組合裝配.DALM一般關(guān)聯(lián)Common庫(kù)中的最底層,最根底的數(shù)據(jù)庫(kù)類(比方：鏈接數(shù)據(jù)庫(kù)),必須關(guān)聯(lián)EntityClass實(shí)體類工程.DALM只是數(shù)據(jù)庫(kù)的治理者,但不是訪問(wèn)者,不直接與數(shù)據(jù)庫(kù)發(fā)生關(guān)聯(lián).數(shù)據(jù)庫(kù)中每個(gè)表都對(duì)應(yīng)一個(gè)DALM的接口(訪問(wèn)限制)類.Comm啖庫(kù)用于存放公用的類.最常用的就是數(shù)據(jù)庫(kù)訪問(wèn)類,比方：鏈接字符串,數(shù)據(jù)庫(kù)引擎類.它直接與數(shù)據(jù)庫(kù)進(jìn)行機(jī)械式的交換,無(wú)任何邏輯.EntityClass實(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、DAE三層的交互主要就是通過(guò)實(shí)體類作為參數(shù),并Return回信息.系統(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)根據(jù)功能角度分解,劃分出假設(shè)干不同的功能模塊,如下面各圖所示:系統(tǒng)功能模塊詳細(xì)設(shè)計(jì)按結(jié)構(gòu)化設(shè)計(jì)方法,在系統(tǒng)功能逐層分解的根底上,對(duì)系統(tǒng)各功能模塊或子系統(tǒng)進(jìn)行設(shè)計(jì).此為詳細(xì)設(shè)計(jì)的主要局部之一.用層次圖描述系統(tǒng)的總體結(jié)構(gòu)、功能分解及各個(gè)模塊之間的相互調(diào)用關(guān)系和信息交互,用IPO圖或其他方法描述各模塊完成的功能.以上建議采用HIPC?進(jìn)行功能分解與模塊描述,更高的要求建議采用IDEF0T法進(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è)模塊的描述說(shuō)明可參照以下格式：模塊編號(hào)：模塊名稱：輸入：處理：算法描述：輸出：其中處理和算法描述局部主要采用偽碼或具體的程序語(yǔ)言完成.對(duì)詳細(xì)設(shè)計(jì)更高的要求建議用IDEF0圖進(jìn)行各功能模塊的設(shè)計(jì).如果對(duì)軟件需進(jìn)行二次開(kāi)發(fā)〔包括功能擴(kuò)展、功能改造、用戶界面改造等〕,那么相應(yīng)的設(shè)計(jì)工作應(yīng)該設(shè)立子課題完成.注意：算法描述主要是說(shuō)明BLLM的代碼邏輯,UI層只做簡(jiǎn)單的輸入驗(yàn)證和界面顯示功能.XXf系統(tǒng)XX真塊列表和分頁(yè)創(chuàng)立XXXX1塊XX^表XX啰改XXf系統(tǒng)用戶治理模塊模塊描述：治理系統(tǒng)用戶,包括添加用戶并賦予角色、修改用戶資料和角色、刪除用戶.主要功能：添加用戶、修改用戶、刪除用戶、列表和分頁(yè).列表和分頁(yè)1、流程圖省略2、輸入項(xiàng)分頁(yè)索引頁(yè)面?zhèn)鲄?shù)頁(yè)面加載時(shí)為13、輸出項(xiàng)列表詳細(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_infoGetAllList()綁定控件,利用gridview自帶分頁(yè)功能,顯示分頁(yè)按鈕、當(dāng)前頁(yè)、分頁(yè)總數(shù)、記錄總數(shù)、.2添加用戶1、流程圖

2、輸入項(xiàng)用戶IDstring必填姓名string必填用戶密碼string必填確認(rèn)密碼string必填聯(lián)系stringE-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ù)；加密密碼使用MD.Encrypt(stringString,stringKey),Key="XXXXXXXX"4)用戶信息保存至表System_admin_info,ExamSys.DAL.System_admin_infoAdd(ExamSys.Model.System_admin_infomodel)；分拆角色I(xiàn)D字符串并循環(huán)字符串?dāng)?shù)組,信息保存至表Dict_admin_vs_roles,ExamSys.BLL.Dict_admin_vs_rolesAdd(ExamSys.Model.Dict_admin_vs_rolesmodel).修改用戶1、流程圖2、輸入項(xiàng)用戶IDstring貝囿傳參數(shù)姓名string必填用戶密碼string必填確認(rèn)密碼string必填

聯(lián)系stringE-mailstring狀態(tài)char用戶角色I(xiàn)Dstring3、輸出項(xiàng)1)成功,UI提示修改用戶完成；2)失敗,UI提示具體信息.4、算法描述1)前端js判斷必填項(xiàng)的輸入和二次密碼是否相同,角色可以不選；"LinLiYan"；admin_vs_rolesadmin_vs_roles2)加密密碼使用Chukeh.Security.M"LinLiYan"；admin_vs_rolesadmin_vs_roles根據(jù)用戶ID刪除表Dict_admin_vs_roles的記錄ExamSys.BLL.Dict.DeleteByAdminID(stringadmin_id)；4)分拆角色I(xiàn)D字符串并循環(huán)字符串?dāng)?shù)組,信息保存至該表ExamSys.BLL.DictAdd(ExamSys.Model.Dict_admin_vs_rolesmodel).刪除用戶1、流程圖2、輸入項(xiàng)用戶IDstring頁(yè)面?zhèn)鲄?shù)3、輸出項(xiàng)1、成功,UI提示刪除用戶完成,刷新列表；2、失敗,UI提示具體信息.3、算法描述根據(jù)用戶ID刪除表System_admin_info的記錄ExamSys.DAL.System_admin_infoDelete(stringadmin_id)；根據(jù)用戶ID刪除表Dict_admin_vs_roles的記錄ExamSys.BLL.Dict_admin_vs_rolesDeleteByAdminID(stringadmin_id).角色治理模塊系統(tǒng)設(shè)置模塊系統(tǒng)登錄注銷模塊5.4系統(tǒng)界面詳細(xì)設(shè)計(jì)系統(tǒng)界面說(shuō)明應(yīng)用系統(tǒng)軟件的各種接口.整個(gè)系統(tǒng)的其他接口(如系統(tǒng)硬件接口、通訊接口等)在相應(yīng)的局部說(shuō)明.外部界面設(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ì).此局部?jī)?nèi)容可能