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

遠程多試驗區(qū)在線考試系統(tǒng)http:/www.Bai /小毛o /電腦系統(tǒng)詳細設(shè)計說明書文件狀態(tài):草稿 正式發(fā)表 正在更改文件id :當前版本:1.0作者:完成日期:版本歷史記錄版本/狀態(tài)作者參加者開始日期備注1.0開始寫作修改唱片。日期修訂版修改文章變更說明作者目錄1引言51.1制作目的51.2背景51.3參考資料51.4術(shù)語的定義和說明52設(shè)計概要52.1任務(wù)和目標52.1.1需求的概要52.1.2運行環(huán)境的概要52.1.3條件和限制62.1.4詳細的設(shè)計方法和工具63系統(tǒng)詳細需求分析63.1詳細的需求分析63.2詳細的系統(tǒng)執(zhí)行環(huán)境和制約條件分析界面需求分析64整體方案確認64.1系統(tǒng)整體的構(gòu)成確認64.2系統(tǒng)詳細接口分類74.2.1應(yīng)用系統(tǒng)和支撐系統(tǒng)的詳細接口劃分74.2.2系統(tǒng)內(nèi)部詳細的接口劃分75系統(tǒng)詳細設(shè)計75.1系統(tǒng)程序代碼架構(gòu)設(shè)計75.1.1用戶界面顯示層75.1.2業(yè)務(wù)邏輯層(bll )業(yè)務(wù)邏輯層85.1.3數(shù)據(jù)訪問層(dal )數(shù)據(jù)訪問層85.1.4Common類庫85.1.5實體類實體類85.2系統(tǒng)結(jié)構(gòu)設(shè)計和子系統(tǒng)劃分85.3系統(tǒng)功能模塊詳細設(shè)計95.3.1XX子系統(tǒng)9. 1XX模塊9清單和分頁符9創(chuàng)建XX9. 2XX模塊9XX清單9XX修正95.3.2XX子系統(tǒng)用戶管理模塊角色管理模塊系統(tǒng)設(shè)定模塊系統(tǒng)登錄取消模塊145.4系統(tǒng)接口的詳細設(shè)計145.4.1外部接口設(shè)計145.4.2內(nèi)部接口設(shè)計145.4.3用戶界面設(shè)計146數(shù)據(jù)庫系統(tǒng)設(shè)計146.1設(shè)計要求146.2信息模型設(shè)計146.3數(shù)據(jù)庫設(shè)計146.3.1設(shè)計依據(jù)146.3.2數(shù)據(jù)庫的種類和特征156.3.3數(shù)據(jù)庫邏輯結(jié)構(gòu)156.3.4物理結(jié)構(gòu)設(shè)計156.3.5數(shù)據(jù)庫安全性156.3.6數(shù)據(jù)詞典157信息代碼設(shè)計157.1代碼結(jié)構(gòu)設(shè)計157.2代碼創(chuàng)建151引言1.1制作目的說明制定詳細的設(shè)計方案的主要目的。說明書制作的目的是說明軟件系統(tǒng)的各階層的程序(各模塊和子程序)和數(shù)據(jù)庫系統(tǒng)的設(shè)計的考慮事項，為程序員代碼提供依據(jù)。在一個軟件系統(tǒng)相對簡單、層次少的情況下，這個文件可以不單獨寫，也可以和概要設(shè)計書中不重復(fù)的部分一起寫。方案側(cè)重于描述模塊的執(zhí)行過程和數(shù)據(jù)庫系統(tǒng)的詳細設(shè)計.1.2背景必須包括以下項目:a .計劃開發(fā)的軟件系統(tǒng)名稱b .該系統(tǒng)的基本概念，例如該系統(tǒng)的類型、從屬地位等c .發(fā)展項目組名稱。1.3參考資料列舉詳細設(shè)計報告引用的文獻、資料、資料的作者、標題、出版單位、出版日期等信息，并說明根據(jù)需要獲得這些資料的方法。1.4術(shù)語的定義和說明列出本文檔中可能被混淆的術(shù)語、定義和縮寫的原文。2設(shè)計概要2.1任務(wù)和目標說明詳細設(shè)計的任務(wù)和詳細設(shè)計要達成的目標。2.1.1需求概要說明開發(fā)的軟件的概要。 需要特別說明系統(tǒng)的性能要求，包括主要業(yè)務(wù)需求、輸入、輸出、主要功能、性能等。2.1.2工作環(huán)境的概要此系統(tǒng)依賴于操作的硬件包括軟件環(huán)境的描述和配置要求，包括操作系統(tǒng)、數(shù)據(jù)庫系統(tǒng)、中間件、接口軟件、可能的性能監(jiān)視和分析等。2.1.3條件和限制詳細說明系統(tǒng)受到的內(nèi)部條件和外部條件的制約和限制。 包括業(yè)務(wù)和技術(shù)方面的條件和限制、進展、管理等限制。2.1.4詳細的設(shè)計方法和工具簡要說明詳細設(shè)計中使用的方法和使用的工具。 盡量采用標準和輔助工具，如HIPO圖法、IDEF(I2DEF )方法、E-R圖、數(shù)據(jù)流圖、業(yè)務(wù)流程圖、選擇的CASE工具等。3系統(tǒng)的詳細需求分析主要分析系統(tǒng)級別的需求。 首先通過需求分析進一步確認提出的企業(yè)需求，詳細分析狀況變化引起的需求變化。3.1詳細的需求分析包括以下內(nèi)容:詳細的功能要求分析詳細的性能要求分析詳細的資源需求分析詳細的系統(tǒng)運用環(huán)境和制約條件分析3.2詳細的系統(tǒng)執(zhí)行環(huán)境和制約條件分析界面需求分析包括以下內(nèi)容:系統(tǒng)接口的要求分析對現(xiàn)有硬件、軟件資源界面的需求分析引入硬、軟件資源界面的需求分析4整體方案的確認重點解決系統(tǒng)整體結(jié)構(gòu)確認和接口分割問題。4.1系統(tǒng)整體的構(gòu)成確認確認系統(tǒng)的構(gòu)成、邏輯結(jié)構(gòu)和層次，確認應(yīng)用系統(tǒng)、支持系統(tǒng)和分別實現(xiàn)的功能，細分集成設(shè)計和系統(tǒng)工作流，特別注意軟件引進引起的系統(tǒng)自身結(jié)構(gòu)和公司其他系統(tǒng)的結(jié)構(gòu)變化。 包括以下內(nèi)容:系統(tǒng)構(gòu)成、邏輯結(jié)構(gòu)、層次確認應(yīng)用系統(tǒng)構(gòu)成確認確認支持系統(tǒng)配置確認系統(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ǎng)絡(luò)和數(shù)據(jù)庫的應(yīng)用系統(tǒng)的支持方式、全局數(shù)據(jù)的管理和訪問方式等。4.2.2系統(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)采用三層結(jié)構(gòu)模型，應(yīng)用系統(tǒng)由用戶界面顯示層、業(yè)務(wù)邏輯層、數(shù)據(jù)訪問層和實體類、公共類庫構(gòu)成，各層的關(guān)系如下圖所示。5.1.1用戶界面顯示層(ui )。負責與用戶的對話、數(shù)據(jù)的顯示、接收，同時進行數(shù)據(jù)有效性判斷的輸入、各種異常的顯示、Dataset記錄集數(shù)據(jù)的處理等簡單的邏輯處理。 它僅與兩個項目(業(yè)務(wù)邏輯層(bll )業(yè)務(wù)邏輯層和實體類實體類)相關(guān)，可能與公共類庫相關(guān)。5.1.2業(yè)務(wù)邏輯層(bll )業(yè)務(wù)邏輯層是整個系統(tǒng)的核心，承擔所有邏輯判斷，實現(xiàn)程序功能，靈活。 BLL層既是調(diào)用者，也是被調(diào)用者，因此必須恰當?shù)卦O(shè)計以達到解除結(jié)合的效果。 BLL層可以僅將DAL層與實體類關(guān)聯(lián)，并將公共類庫與實體類關(guān)聯(lián)。 BLL層被u層調(diào)用，而BLL層不需要在意UI層的狀況。 數(shù)據(jù)庫中的每個表都對應(yīng)于BLL類，為了實現(xiàn)解綁定效果，BLL類不能直接調(diào)用其他表的DAL類，而是可以在BLL類之間相互調(diào)用。5.1.3數(shù)據(jù)訪問層(dal )數(shù)據(jù)訪問層提供數(shù)據(jù)訪問的接口，沒有邏輯。 在接口上組合數(shù)據(jù)庫操作語句。 DAL層通常是公共類庫的最低級別，必須與最基本的數(shù)據(jù)庫類(例如，到數(shù)據(jù)庫的鏈接)相關(guān)聯(lián)，并與實體類實體類項相關(guān)聯(lián)。 DAL層是數(shù)據(jù)庫的管理員，但不是訪問者，而是與數(shù)據(jù)庫直接相關(guān)。 數(shù)據(jù)庫中的每個表都對應(yīng)于DAL層的接口(訪問控制)類。5.1.4公共程序庫用于存儲共同的類。 最常見的是數(shù)據(jù)庫訪問類。 例如，鏈接字符串、數(shù)據(jù)庫引擎類。 與數(shù)據(jù)庫直接機械交換，不合邏輯。5.1.5實體類實體類相當于強化了的數(shù)據(jù)結(jié)構(gòu)，實現(xiàn)了數(shù)據(jù)的封裝。 數(shù)據(jù)庫中的每個表對應(yīng)于實體類，表中的字段對應(yīng)于實體類的屬性，類型一對一對應(yīng)。 UI、BLL、DAL三層的交互主要以實體類為參數(shù)，通過Return返回信息。5.2系統(tǒng)結(jié)構(gòu)設(shè)計和子系統(tǒng)劃分根據(jù)業(yè)務(wù)和功能，將系統(tǒng)的邏輯結(jié)構(gòu)分為XX子系統(tǒng)、XX子系統(tǒng)等6個子系統(tǒng)。 下圖所示。XXXXXXXX系統(tǒng)XX管理子系統(tǒng)XX管理子系統(tǒng)XX子系統(tǒng)XX子系統(tǒng)XX子系統(tǒng)XX子系統(tǒng)各子系統(tǒng)根據(jù)功能的角度進行分解，如下圖所示分為幾個不同的功能模塊5.3系統(tǒng)功能模塊的詳細設(shè)計根據(jù)結(jié)構(gòu)化設(shè)計方法，在逐步分解系統(tǒng)功能的基礎(chǔ)上，設(shè)計系統(tǒng)的各功能模塊和子系統(tǒng)。 這是詳細設(shè)計的主要部分之一。用分層圖描述系統(tǒng)的整體結(jié)構(gòu)、功能分解和各模塊間的相互調(diào)用關(guān)系和信息交換，用IPO圖和其他方法描述各模塊完成的功能。 以上提案用HIPO圖進行功能分解和模塊描述，更高的要求用IDEF0方法進行功能模型設(shè)計。詳細設(shè)計了應(yīng)用系統(tǒng)各構(gòu)成模塊完成的功能及其相互關(guān)系，用IPO和結(jié)構(gòu)圖描述各模塊的構(gòu)成結(jié)構(gòu)、算法、模塊之間的接口關(guān)系、需求、功能和模塊之間的相互參照關(guān)系。每個模塊的說明可以參考以下格式:模塊編號:模塊名稱:輸入:處理:算法說明:輸出:其中，處理和算法的描述部分主要用偽碼或具體的程序語言完成。對于要求更詳細的設(shè)計的要求，使用IDEF0圖進行各功能模塊的設(shè)計。在需要二次開發(fā)軟件的情況下(包括功能擴展、功能改造、用戶界面改造等)，相應(yīng)的設(shè)計工作必須設(shè)置子課題來完成。注意:算法的說明主要說明BLL層的代碼邏輯，UI層只進行簡單的輸入驗證和界面顯示功能。5.3.1 XX子系統(tǒng).1 XX模塊列表和分頁符創(chuàng)建XX. 2 XX模塊XX列表XX變更5.3.2 XX子系統(tǒng)用戶管理模塊模塊說明:管理系統(tǒng)用戶，包括添加和授予用戶、修改用戶數(shù)據(jù)和角色以及刪除用戶。主要功能:添加用戶、更改用戶、刪除用戶、列表和分頁。.1列表和尋呼1 .流程圖省略2 .輸入項分頁索引頁傳輸參數(shù)頁加載時為13 .輸出項1 )列表詳細記錄2 )當前頁碼3 )尋呼總數(shù)4 )唱片總數(shù)。4 .算法的說明系統(tǒng)管理用戶的數(shù)據(jù)量少，而且此功能不經(jīng)常使用，因此可以在不優(yōu)化分頁的情況下獲取用戶表的所有記錄，并在UI層使用gridview控件來獲取examplesys.bll.system _ admin _ infog 調(diào)用綁定控件，利用gridview的分頁功能顯示分頁按鈕、當前頁面、分頁總數(shù)、記錄總數(shù)，.2添加用戶1 .流程圖輸入用戶數(shù)據(jù)。選擇角色加密密碼。填寫合規(guī)性。用戶信息保存在System_admin_info表中必要項目的驗證認證用戶名是否存在成功與否。分割角色ID字符串循環(huán)字符串數(shù)組將信息保存到表Dict_admin_vs_roles中返回成功信息是的，是的。否是的，是的。返回失敗信息否是的，是的。否操作日志2 .輸入項用戶id字符串是必需的名稱字符串是必需的用戶密碼string是必需的我需要確認密碼字符串。聯(lián)系電話string電子郵件字符串狀態(tài)char用戶角色id字符串3 .輸出項1 )成功，UI通知用戶添加完成2 )失敗，UI提示具體信息。4 .算法的說明1 )開頭js判斷必要項目的輸入和二次密碼是否相同，也可以不選擇角色2) BLL需要驗證必要項目，用戶名是唯一不可重復(fù)的3 )加密密碼是MD5 .加密(字符串，字符串密鑰)，密鑰=xxxxxxxx ；4 )用戶信息保存在表System_admin_info，examplesys.dal.system _ admin _ info add (examplesys.model.system _ admin _ info model )中5 )分割角色ID字符串，使字符串數(shù)組循環(huán)，并將信息表示為Dict_admin_vs_roles，examples.bll.dict _ admin _ vs _ roles add (examples.model.dict _ admin _ vs.3用戶的變更1 .流程圖輸入用戶數(shù)據(jù)。選擇角色填寫合規(guī)性。用戶信息保存在System_admin_info表中必要項目的驗證加密密碼。成功與否。分割角色ID字符串循環(huán)字符串數(shù)組將信息保存到表Dict_admin_vs_roles中返回成功信息是的，是的。是的，是的。返回失敗信息否否根據(jù)用戶ID刪除表Dict_admin_vs_roles記錄成功與否。是的，是的。否操作日志2 .輸入項用戶IDstring頁傳輸參數(shù)名稱字符串是必需的用戶密碼string是必需的你需要確認密碼字符串。聯(lián)系電話string電子郵件字符串狀態(tài)char用戶角色id字符串3 .輸出項1 )成功，UI提示用戶修改2 )失敗，UI提示具體信息。4 .算法的說明1 )開頭js判斷必要項目的輸入和二次