概要設計文檔最佳實例

/HUST學分制教務管理系統(tǒng)概要設計說明書Version1.1文擋編號hust_gaiyaosheji文擋名稱概要設計文檔撰寫人歐高炎審核/批準創(chuàng)建時間2008-12-25更改說明版本號更改時間更改人更改原因審批人Version1.0Version1.12008-12-27歐高炎參考資料欄的筆誤進行了更正目錄1引言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)數(shù)據(jù)結構設計137系統(tǒng)出錯處理設計137.1出錯信息137.2補救措施131引言1.1編寫目的為明確HUST學分制教務管理系統(tǒng)的系統(tǒng)結構、安排項目規(guī)劃與進度、制定詳細測試計劃、組織軟件開發(fā)與測試.特撰寫本文檔。本文檔供項目經(jīng)理、設計人員、開發(fā)人員參考。1.2背景開發(fā)軟件名稱：HUST學分制教務管理系統(tǒng)項目任務提出者：華中科技大學教務處項目開發(fā)者：ZOWL團隊用戶：華中科技大學學生.教務管理人員實現(xiàn)軟件單位：ZOWL團隊項目與其他軟件.系統(tǒng)的關系：該系統(tǒng)需要在學生成績管理系統(tǒng).學生選課系統(tǒng)等已有系統(tǒng)直接復制數(shù)據(jù).所以在定義數(shù)據(jù)時要與已有系統(tǒng)相兼容。本系統(tǒng)采用B/S.服務器端采用MicrosoftServer2003為操作系統(tǒng)的工作站.是采用MicrosoftSQLServer2005的為開發(fā)軟件的數(shù)據(jù)庫服務程序。1.3定義SQL：結構化查詢語言.關系數(shù)據(jù)庫查詢的標準語言；SQLSERVER2005：微軟公司生產(chǎn)的SQLSERVER數(shù)據(jù)庫管理系統(tǒng)；1.4參考資料《華中科技大學本科學分制學籍管理條例》《華中科技大學學分制選課辦法》《華中科技大學學生學號編碼管理辦法》編號hust_FSR：《可行性研究報告》鎮(zhèn)祎編號hust_xiangmujihua：《項目計劃說明書》汪瑤編號hust_xuqiuguifan《需求規(guī)范說明書》歐高炎2任務概述2.1目標因大量用戶需要使用本系統(tǒng)的前臺.所以決定采用B/S體系來設計本系統(tǒng)。教務管理人員登錄本系統(tǒng)后.系統(tǒng)列出多有可供使用的功能模塊.主要有八大模塊：學籍管理、注冊管理、教師信息管理、學生信息管理、成績管理、課程管理、選課與排課管理、教務通知管理。教務管理人員工作時可以選擇相應的功能模塊進行快捷方便的教務管理。學生隨時隨地可以利用互聯(lián)網(wǎng).來進行查詢個人基本信息、成績查詢、注冊狀態(tài)查詢、課表下載.還可以查看教務人員發(fā)布的教務通知.方便地了解成績、課程、通知等信息。教師用戶同樣可以隨時隨地進行進行教務通知查看、同時進行成績錄入工作。本系統(tǒng)基于UML建模.概要設計應輸出用例圖.主要用例的順序圖.系統(tǒng)的主要類圖。2.2運行環(huán)境硬件及軟件環(huán)境：1臺服務器：PIII1.2G雙CPU.SCSI雙硬盤鏡像.1G以上內存.WindowsNT.Apache+JSP+SQLSERVER2005服務器；客戶機為普通支持瀏覽器的PC機；系統(tǒng)運行環(huán)境示意圖如下：2.3需求概述旨在開發(fā)一個統(tǒng)一的網(wǎng)上教務信息管理平臺.利用信息化手段輔助教學管理.達到提升我校教學管理信息化水平的目的。教務管理人員能夠更方便地進行教務管理工作.包括學籍管理.注冊管理.教師信息管理.學生信息管理.成績管理.課程管理.選課與排課管理.以及教務通知管理等；學生用戶能夠利用該系統(tǒng)進行成績查詢.個人選課操作.查看教務通知.課表下載等；教師則能夠進行成績錄入.查看教務通知等。HUST學分制成績管理系統(tǒng)主要需求列表如下：學籍管理功能。包括轉專業(yè)管理、停學、休學、復學、退學、延長學習年限。在進行學籍管理各子功能的操作時.操作界面應統(tǒng)一、直觀。其中轉專業(yè)時應包括的信息為〔學號、轉專業(yè)記錄號、原轉出院系、原轉出專業(yè)、原轉出班級、現(xiàn)轉入院系、現(xiàn)轉入專業(yè).而停、休、復、退學則內容一致〔學號、姓名、院系、專業(yè)、停學時間、停學原因、醫(yī)院意見、班主任意見、院系意見、備注。注冊管理功能。包括個人注冊查詢與注冊操作、班級批量注冊查詢與操作。個人注冊管理時.只顯示個人的注冊狀態(tài)及相關信息；而班級注冊管理時則顯示班級各成員的注冊信息列表.能夠支持統(tǒng)一處理。教師信息管理。包括教師信息查詢、修改、添加和刪除。學生信息管理。包括學生信息查詢、修改、添加和刪除。成績管理。包括成績錄入、成績報表〔個人學期、學年、綜合成績報表；班級學年加權、綜合加權成績表、學分統(tǒng)計表；年級加權成績一覽表。各種成績報表的格式參見《需求規(guī)范說明書》。課程管理。包括課程信息查詢、修改、添加和刪除。選課與排課管理。包括班級批量選課、個人選課；課表導入〔上傳、課表導出〔下載。不需要提供排課功能.只需要實現(xiàn)課表文件的導入與導出。即實現(xiàn)上傳與下載功能。教務通知管理。包括通知查詢、修改、添加和刪除。教務管理人員進行通知修改、添加和刪除。教師和學生進行查看。3總體設計3.1基本設計概念和處理流程針對本系統(tǒng)的教務管理人員、學生、教師三種不同的角色.系統(tǒng)的處理流程如下圖所示：圖2.1教務管理人員登錄時的系統(tǒng)流程圖圖2.2學生和教師登錄時的系統(tǒng)流程圖3.2結構用一覽表及框圖的形式說明本系統(tǒng)的系統(tǒng)元素〔各層模塊、子程序、公用程序等的劃分.扼要說明每個系統(tǒng)元素的標識符和功能.分層次地給出各元素之間的控制與被控制關系.本系統(tǒng)的體系架構如圖3所示：本系統(tǒng)體系結構大致可以定義為：客戶機層上的表示層主要是通過Struts框架實現(xiàn)的.由顯示視圖產(chǎn)生一個請求。請求被ActionServlet〔控制器接收.它在struts-config.xml文件中尋找請求的URI.找到對應的Action類后.Action類執(zhí)行相應的業(yè)務邏輯。Action類執(zhí)行建立在模型組件基礎上的業(yè)務邏輯.模型組件是和應用程序關聯(lián)的。一旦Action類處理完業(yè)務邏輯.它把控制權返回給ActionServlet。.Action類提供一個鍵值作為返回的一部分.它指明了處理的結果。ActionServlet使用這個鍵值來決定在什么視圖中顯示Action的類處理結果。當ActionServlet把Action類的處理結果傳送到指定的視圖中.請求的過程也就完成了。中間業(yè)務層是通過Spring框架實現(xiàn)的.首先建立一個BaseAction,它繼承了Action類.而其他定義的Action都要繼承這個BaseAction。這個BaseAction需要導入AppContext工具類.這個AppContext需要導入Spring中org.springframework.context.support.*；這樣一個繼承BaseAction的Action.就可以getXXXService<>的方法得到某一個service的實例服務定位器的設計模式。持久〔PO層是由hibernate架構實現(xiàn)的.它包括關于整體數(shù)據(jù)庫的hibernate.cfg.xml文件、每個表的JavaBean類和每個表的hbm.xml文件.通過Spring集成模板HibernateTemplate提供DAO來使用PO。在Spring的配置文件〔applicationContext.xml中配置sessionFactory的bean來管理hibernate。教務管理員擁有所有功能權限.學生和教師所有的功能均為教務管理員功能的子集。故系統(tǒng)只對管理員的角度進行設計.學生和教師模塊可以直接復用相關模塊完成其功能。本系統(tǒng)組件圖如圖4所示：3.3功能分配本系統(tǒng)中各功能需求與程序模塊〔組件之間的關系如下圖所示：功能需求學籍管理注冊管理教師管理學生管理成績管理課程管理選課與排課管理教務通知管理轉專業(yè)管理停學休學復學退學延長學習年限個人注冊操作班級注冊操作個人注冊狀態(tài)查詢班級注冊狀態(tài)查詢教師信息查詢教師添加教師修改教師刪除學生信息查詢學生添加學生修改學生刪除成績錄入個人成績報表班級成績報表年級成績報表課程信息查詢課程添加課程修改課程刪除課表發(fā)布課表查看班級批量選課個人選課教務通知查看教務通知發(fā)布教務通知修改教務通知刪除4接口設計4.1用戶接口在用戶界面部分.根據(jù)需求分析的結果.用戶需要一個用戶友善界面。在界面設計上.應做到簡單明了.易于操作.并且要注意到界面的布局.應突出的顯示重要以及出錯信息?？梢允褂肈reamweaver網(wǎng)頁設計工具直接拖曳出美觀、簡介、友善的用戶接口。其中針對教務管理人員的界面要做到操作簡單.易于管理。在設計上采用逐級下拉式菜單方式.但菜單層數(shù)最多不能超過4層。同時.運行出錯時應以標準形式給出出錯提示?？偟膩碚f.系統(tǒng)的用戶界面應作到可靠性、簡單性、易學習和使用。4.2外部接口服務器端程序可DAO〔數(shù)據(jù)訪問對象應用程序編程接口〔API.對SQLSERVER數(shù)據(jù)庫進行所有的訪問。服務器程序上可使用SQLSERVER的對數(shù)據(jù)庫的備分命令.以做到對數(shù)據(jù)的保存。在網(wǎng)絡軟件接口方面.使用一種無差錯的傳輸協(xié)議.采用滑動窗口方式對數(shù)據(jù)進行網(wǎng)絡傳輸及接收。4.3內部接口教師信息管理模塊。對其他模塊提供對課程的查詢接口。學生信息管理模塊。對其他模塊提供對學生信息查詢的接口.包括按學號查詢和按姓名查詢和按班級查詢三種。課程管理模塊。對其他模塊提供對課程信息查詢的接口.包括按課程編號查詢、按課程名查詢等。5運行設計5.1運行模塊組合客戶機程序在有輸入時啟動接收數(shù)據(jù)模塊.通過各模塊之間的調用.讀入并對輸入進行格式化。在接收數(shù)據(jù)模塊得到充分的數(shù)據(jù)時.將調用網(wǎng)絡傳輸模塊.將數(shù)據(jù)通過網(wǎng)絡送到服務器.并等待接收服務器返回的信息。接收到返回信息后隨即調用數(shù)據(jù)輸出模塊.對信息進行處理.產(chǎn)生相應的輸出。服務器程序的接收網(wǎng)絡數(shù)據(jù)模塊必須始終處于活動狀態(tài)。接收到數(shù)據(jù)后.調用數(shù)據(jù)處理/查詢模塊對數(shù)據(jù)庫進行訪問.完成后調用網(wǎng)絡發(fā)送模塊.將信息返回客戶機。5.2運行控制運行控制將嚴格按照各模塊間函數(shù)調用關系來實現(xiàn)。在各事務中心模塊中.需對運行控制進行正確的判斷.選擇正確的運行控制路徑。在網(wǎng)絡傳方面.客戶機在發(fā)送數(shù)據(jù)后.將等待服務器的確認收到信號.收到后.再次等待服務器發(fā)送回答數(shù)據(jù).然后對數(shù)據(jù)進行確認。服務器在接到數(shù)據(jù)后發(fā)送確認信號.在對數(shù)據(jù)處理、訪