概要設計文檔最佳實例

1、HUST 學分制教務管理系統(tǒng)概要設計說明書編號 :hust_gaiyaoshejiHUST 學分制教務管理系統(tǒng)概要設計說明書Version1.1文擋編號hust_gaiyaosheji文擋名稱概要設計文檔撰寫人歐高炎審核 /批準創(chuàng)建時間2008-12-25Page1of13HUST 學分制教務管理系統(tǒng)概要設計說明書編號 :hust_gaiyaosheji更改說明版本號更改時間更改人更改原因審批人Version1.0Version1.12008-12-27歐高炎參考資料欄的筆誤進行了更正Page2of13HUST 學分制教務管理系統(tǒng)概要設計說明書編號 :hust_gaiyaosheji目 錄1引

2、言 .41.1編寫目的 .41.2背景 .41.3定義 .41.4參考資料 .42 任務概述 .52.1目標 .52.2運行環(huán)境 .52.3需求概述 .63總體設計 .63.1基本設計概念和處理流程 .63.2結構 .93.3功能分配 .104接口設計 .114.1用戶接口 .114.2外部接口 .124.3內部接口 .125運行設計 .125.1運行模塊組合 .125.2運行控制 .125.3運行時間 .136系統(tǒng)數據結構設計 .137系統(tǒng)出錯處理設計 .137.1出錯信息 .137.2補救措施 .13Page3of13HUST 學分制教務管理系統(tǒng)概要設計文檔編號:hust_gaiyaosh

3、eji1 引言1.1 編寫目的為明確 HUST 學分制教務管理系統(tǒng)的系統(tǒng)結構、安排項目規(guī)劃與進度、制定詳細測試計劃、組織軟件開發(fā)與測試，特撰寫本文檔。本文檔供項目經理、設計人員、開發(fā)人員參考。1.2 背景開發(fā)軟件名稱：HUST 學分制教務管理系統(tǒng)項目任務提出者：華中科技大學教務處項目開發(fā)者：ZOWL 團隊用戶：華中科技大學學生，教務管理人員實現軟件單位：ZOWL 團隊項目與其他軟件，系統(tǒng)的關系：該系統(tǒng)需要在學生成績管理系統(tǒng)， 學生選課系統(tǒng)等已有系統(tǒng)直接復制數據， 所以在定義數據時要與已有系統(tǒng)相兼容。本系統(tǒng)采用 B/S ，服務器端采用 Microsoft Server 2003 為操作系統(tǒng)的工作

4、站， 是采用 Microsoft SQL Server 2005 的為開發(fā)軟件的數據庫服務程序。1.3 定義SQL ：結構化查詢語言，關系數據庫查詢的標準語言；SQL SERVER 2005 ：微軟公司生產的SQL SERVER 數據庫管理系統(tǒng)；1.4 參考資料華中科技大學本科學分制學籍管理條例華中科技大學學分制選課辦法華中科技大學學生學號編碼管理辦法編號 hust_FSR：可行性研究報告鎮(zhèn)祎編號hust_xiangmujihua ：項目計劃說明書汪瑤編號hust_xuqiuguifan 需求規(guī)范說明書歐高炎page4of13HUST 學分制教務管理系統(tǒng)概要設計文檔編號:hust_gaiyao

5、sheji2 任務概述2.1 目標因大量用戶需要使用本系統(tǒng)的前臺，所以決定采用B/S 體系來設計本系統(tǒng)。教務管理人員登錄本系統(tǒng)后，系統(tǒng)列出多有可供使用的功能模塊，主要有八大模塊：學籍管理、 注冊管理、 教師信息管理、 學生信息管理、 成績管理、 課程管理、 選課與排課管理、教務通知管理。教務管理人員工作時可以選擇相應的功能模塊進行快捷方便的教務管理。學生隨時隨地可以利用互聯(lián)網，來進行查詢個人基本信息、成績查詢、注冊狀態(tài)查詢、課表下載，還可以查看教務人員發(fā)布的教務通知，方便地了解成績、課程、通知等信息。教師用戶同樣可以隨時隨地進行進行教務通知查看、同時進行成績錄入工作。本系統(tǒng)基于UML 建模，概

6、要設計應輸出用例圖，主要用例的順序圖，系統(tǒng)的主要類圖。2.2 運行環(huán)境硬件及軟件環(huán)境：1 臺服務器：PIII1.2G雙 CPU ， SCSI 雙硬盤鏡像，1G 以上內存，WindowsNT ，Apache+JSP+SQLSERVER 2005 服務器；客戶機為普通支持瀏覽器的PC 機；系統(tǒng)運行環(huán)境示意圖如下：用戶終端 1INTERNET用戶終端 2服務器用戶終端 N數據庫圖1 系統(tǒng)環(huán)境示意圖page5of13HUST 學分制教務管理系統(tǒng)概要設計文檔編號:hust_gaiyaosheji2.3 需求概述旨在開發(fā)一個統(tǒng)一的網上教務信息管理平臺，利用信息化手段輔助教學管理，達到提升我校教學管理信息化

7、水平的目的。 教務管理人員能夠更方便地進行教務管理工作， 包括學籍管理，注冊管理，教師信息管理，學生信息管理，成績管理，課程管理，選課與排課管理，以及教務通知管理等； 學生用戶能夠利用該系統(tǒng)進行成績查詢， 個人選課操作， 查看教務通知，課表下載等；教師則能夠進行成績錄入，查看教務通知等。HUST 學分制成績管理系統(tǒng)主要需求列表如下：? 學籍管理功能。包括轉專業(yè)管理、停學、休學、復學、退學、延長學習年限。在進行學籍管理各子功能的操作時， 操作界面應統(tǒng)一、 直觀。其中轉專業(yè)時應包括的信息為（學號、轉專業(yè)記錄號、原轉出院系、原轉出專業(yè)、原轉出班級、現轉入院系、現轉入專業(yè)），而停、休、復、退學則內容一

8、致（學號、姓名、院系、專業(yè)、停學時間、停學原因、醫(yī)院意見、班主任意見、院系意見、備注） 。? 注冊管理功能 。包括個人注冊查詢與注冊操作、班級批量注冊查詢與操作。個人注冊管理時，只顯示個人的注冊狀態(tài)及相關信息；而班級注冊管理時則顯示班級各成員的注冊信息列表，能夠支持統(tǒng)一處理。? 教師信息管理。包括教師信息查詢、修改、添加和刪除。? 學生信息管理。包括學生信息查詢、修改、添加和刪除。? 成績管理。包括成績錄入、成績報表（個人學期、學年、綜合成績報表；班級學年加權、綜合加權成績表、學分統(tǒng)計表；年級加權成績一覽表）。各種成績報表的格式參見需求規(guī)范說明書。? 課程管理。包括課程信息查詢、修改、添加和刪

9、除。? 選課與排課管理。包括班級批量選課、個人選課；課表導入（上傳）、課表導出（下載） 。不需要提供排課功能，只需要實現課表文件的導入與導出。即實現上傳與下載功能。? 教務通知管理。包括通知查詢、修改、添加和刪除。教務管理人員進行通知修改、添加和刪除。教師和學生進行查看。3 總體設計3.1 基本設計概念和處理流程針對本系統(tǒng)的教務管理人員、學生、教師三種不同的角色，系統(tǒng)的處理流程如下圖所示：page6of13HUST 學分制教務管理系統(tǒng)概要設計文檔編號:hust_gaiyaoshejiHUST 學分制教務管理系統(tǒng)教務管理人員登錄學籍管理教務管理員注冊管理教師信息管理學生信息管理課程管理成績管理選

10、課與排課管理教務通知管理轉專業(yè)管理停學復學休學退學延長學習年限注冊狀態(tài)查詢注冊操作教師信息查詢教師信息修改教師信息添加教師信息刪除學生信息查詢學生信息修改學生信息添加學生信息刪除課程信息查詢課程信息修改課程信息添加課程信息刪除成績錄入成績報表排課選課教務通知查看教務通知發(fā)布教務通知修改教務通知刪除學籍信息相關信息文件個人注冊狀態(tài)查詢批量注冊狀態(tài)查詢教師信息文件學生信息文件課程信息文件個人成績報表班級成績報表年級成績報表個人選課批量選課教務通知信息文件學生注冊信息文件成績信息文件選課與排課信息文件圖 2.1 教務管理人員登錄時的系統(tǒng)流程圖page7of13HUST 學分制教務管理系統(tǒng)概要設計文檔

11、編號:hust_gaiyaoshejiHUST學分制教務管理系統(tǒng)教師登錄學生登錄學生注冊狀態(tài)查詢學生注冊信個人信息中心息文件學生信息查詢學生信息文件課程信息查詢課程信息文件課程管理個人選課選課信息文課表下載件課表信息文學期成績件成績查看學年成績成績信息文綜合成績件教務通知查看教務通知文件教師信息文教師信息查看件教師成績錄入所授課程查看教務通知查看圖 2.2 學生和教師登錄時的系統(tǒng)流程圖page8of13HUST 學分制教務管理系統(tǒng)概要設計文檔編號:hust_gaiyaosheji3.2 結構用一覽表及框圖的形式說明本系統(tǒng)的系統(tǒng)元素（各層模塊、子程序、公用程序等）的劃分，扼要說明每個系統(tǒng)元素的標

12、識符和功能，分層次地給出各元素之間的控制與被控制關系.本系統(tǒng)的體系架構如圖3 所示：表示層控制層業(yè)務層持久層圖 3系統(tǒng)架構圖本系統(tǒng)體系結構大致可以定義為：客戶機層上的表示層主要是通過Struts 框架實現的，由顯示視圖產生一個請求。請求被 ActionServlet （控制器）接收，它在struts-config.xml文件中尋找請求的 URI ，找到對應的Action 類后， Action 類執(zhí)行相應的業(yè)務邏輯。Action類執(zhí)行建立在模型組件基礎上的業(yè)務邏輯，模型組件是和應用程序關聯(lián)的。一旦Action 類處理完業(yè)務邏輯，它把控制權返回給ActionServlet 。， Action 類提

13、供一個鍵值作為返回的一部分，它指明了處理的結果。ActionServlet 使用這個鍵值來決定在什么視圖中顯示Action 的類處理結果。當 ActionServlet 把 Action 類的處理結果傳送到指定的視圖中，請求的過程也就完成了。中間業(yè)務層是通過Spring 框架實現的，首先建立一個BaseAction, 它繼承了 Action類，而其他定義的 Action 都要繼承這個 BaseAction 。這個 BaseAction 需要導入 AppContext 工具類，這個 AppContext 需要導入 Spring 中；這樣一個繼承 BaseAction 的 Action ，就可以

14、getXXXService() 的方法得到某一個 service 的實例 -服務定位器的設計模式。持久（PO）層是由hibernate 架構實現的，它包括關于整體數據庫的文件、每個表的JavaBean 類和每個表的hbm.xml 文件，通過Spring 集成 模 板HibernateTemplate提 供DAO來 使 用PO 。 在Spring的 配 置 文 件page9of13HUST 學分制教務管理系統(tǒng)概要設計文檔編號:hust_gaiyaosheji（ applicationContext.xml ）中配置 sessionFactory 的 bean 來管理 hibernate。教務管理

15、員擁有所有功能權限，學生和教師所有的功能均為教務管理員功能的子集。故系統(tǒng)只對管理員的角度進行設計，學生和教師模塊可以直接復用相關模塊完成其功能。本系統(tǒng)組件圖如圖4 所示：用戶登業(yè)務調錄度教師管理學生管成績管課程管理選課與排學籍管理注冊管理理理課管理數據鏈接DAO組件持久實體XML解析器圖4 系統(tǒng)組件圖3.3 功能分配本系統(tǒng)中各功能需求與程序模塊（組件）之間的關系如下圖所示：教務通知管理功能需求轉專業(yè)管理停學休學復學退學延長學習年限個人注冊操作班級注冊操作個人注冊狀態(tài)查詢選課務教學籍注冊教師學生成績課程與排知管理管理管理管理管理管理課通管理管理?page 10 of13HUST 學分制教務管理系

16、統(tǒng)概要設計文檔編號:hust_gaiyaosheji班級注冊狀態(tài)查詢教師信息查詢教師添加教師修改教師刪除學生信息查詢學生添加學生修改學生刪除成績錄入個人成績報表班級成績報表年級成績報表課程信息查詢課程添加課程修改課程刪除課表發(fā)布課表查看班級批量選課個人選課教務通知查看教務通知發(fā)布教務通知修改教務通知刪除?4 接口設計4.1 用戶接口在用戶界面部分，根據需求分析的結果，用戶需要一個用戶友善界面。在界面設計上，應做到簡單明了，易于操作，并且要注意到界面的布局，應突出的顯示重要以及出錯信息。可以使用Dreamweaver 網頁設計工具直接拖曳出美觀、簡介、友善的用戶接口。其中針對教務管理人員的界面要

17、做到操作簡單，易于管理。 在設計上采用逐級下拉式菜單方式，但菜單層數最多不能超過4 層。同時，運行出錯時應以標準形式給出出錯提示。總的來說，系統(tǒng)的用戶界面應作到可靠性、簡單性、易學習和使用。page 11 of13HUST 學分制教務管理系統(tǒng)概要設計文檔編號:hust_gaiyaosheji4.2 外部接口服務器端程序可DAO （數據訪問對象）應用程序編程接口（API ），對 SQL SERVER數據庫進行所有的訪問。服務器程序上可使用SQL SERVER 的對數據庫的備分命令，以做到對數據的保存。在網絡軟件接口方面，使用一種無差錯的傳輸協(xié)議，采用滑動窗口方式對數據進行網絡傳輸及接收。4.3

18、內部接口? 教師信息管理模塊。對其他模塊提供對課程的查詢接口。? 學生信息管理模塊。對其他模塊提供對學生信息查詢的接口，包括按學號查詢和按姓名查詢和按班級查詢三種。? 課程管理模塊。對其他模塊提供對課程信息查詢的接口，包括按課程編號查詢、按課程名查詢等。5 運行設計5.1 運行模塊組合客戶機程序在有輸入時啟動接收數據模塊，通過各模塊之間的調用，讀入并對輸入進行格式化。 在接收數據模塊得到充分的數據時，將調用網絡傳輸模塊，將數據通過網絡送到服務器， 并等待接收服務器返回的信息。接收到返回信息后隨即調用數據輸出模塊，對信息進行處理，產生相應的輸出。服務器程序的接收網絡數據模塊必須始終處于活動狀態(tài)。接收到數據后， 調用數據處理/ 查詢模塊對數據庫進行訪問，完成后調用網絡發(fā)送模塊，將信息返回客戶機。5.2 運行控制運行控制將嚴格按照各模塊間函數調用關系來實現。在各事務中心模塊中，需對運行控制進行正確的判斷，選擇正確的運行控制路徑。在網絡傳方面，客戶機在發(fā)送數據后，將等待服務器的確認收到信號，收到后，再次等待服務器發(fā)送回答數據， 然后對數據進行確認。 服務器在接到數據后發(fā)送確認信號， 在對數據處理、訪問數據庫后，將返回信息送回客戶機，并等待確認。page 12 of13HUST 學分制教務管理系統(tǒng)概要設計文檔編號:hust_gaiyaosheji5.3 運行時間在軟體的需求分析中， 對