注意:該文檔為word文檔,想要模板請回復關鍵字「詳細設計說明書」。
北京市某某系統詳細設計
版本:[1.4]
北京象速藍鯨科技有限公司
版權所有 侵權必究
修訂記錄
目錄
第一章引言
1.1編寫目的
1.2背景
1.3範圍
1.4定義
1.5參考資料
第二章 程序系統體系結構
2.1應用系統設計框架
2.1.1應用系統層
2.1.2應用平臺層
2.1.3數據資源層
第三章 模塊詳細設計
3.1主學習流程
3.2門戶系統詳細設計
3.2.1核心結構和功能分配
3.2.2核心頁面流轉圖
3.2.3核心功能模塊設計
3.2.3.1門戶通知通告調用功能
第四章 全局數據結構說明
第五章 核心程序和算法設計
5.1平臺(Plat)設計說明
5.1.1數據結構說明
5.1.2算法及流程
5.1.3數據存儲說明
5.1.4源程序文件說明
5.1.5函數說明
第一章引言
1.1編寫目的
「某某系統」核心的開發理念是「以人為本」,各種界面、功能、環節的設計和連接,應時時處處都體現對用戶的尊重、對學習的支持與鼓勵,體現學習的效率,彰顯學習的快樂。
本文檔為開發人員提供依據,項目開發小組以此文檔為基礎進行編碼工作。
1.2背景
為滿足學員不斷增加、課件日益豐富、功能更加完善的需求,北京市墨眸系統的二期建設工程已經啟動。本項目作為北京市某某系統的二期建設工程,在完善一期項目的同時,將提高系統性能,擴充平臺規模,增加系統功能,更好地為北京市各級領導幹部服務。為各級幹部提供一個靈活便捷,滿足個性化、差別化學習需求,有效緩解工學矛盾的學習平臺,使在線學習成為推進大規模培訓幹部工作的一個重要手段。
1.3範圍
本文檔對北京市某某系統管理和前臺應用進行規劃、設計以及接口說明
1.4定義
UUM統一用戶管理
Aicc標準
Scorm標準
1.5參考資料
《需求規格說明書》
《概要設計說明書》
Aicc、Scorm規範
第二章 程序系統體系結構
2.1應用系統設計框架
北京市某某系統二期總體應用架構從上至下將由應用系統層、應用平臺層、資源層構成。整個架構集中體現:以數據資源層為依託,以應用系統層和應用平臺層為核心,全面為幹部學員、市委組織部及各級組織人事部門、在線學習中心提供高效、易用的個性化服務。(下圖所示)
2.1.1應用系統層
應用系統層是整個應用架構的核心,該層通過調用應用平臺層的中間件資源,以部件化或非部件化的形式包裝,構建應用邏輯群。應用系統層分為在線學習系統、幹部培訓檔案管理系統、綜合管理系統、師資管理系統和運行監控系統等。
2.1.2應用平臺層
應用平臺層與應用系統層共同構成整個應用架構的核心,應用平臺層的公共組件構成應用基礎系統,是應用系統層的軟體支撐平臺。通過支撐層,可以快速創建、組裝、部署和管理動態的健壯的應用邏輯。支撐層分兩個層面,最底層是基礎開發平臺,即應用開發環境和系統平臺開發接口。在此之上是公共組件,提供了可工作於不同應用系統的核心服務功能,作為應用邏輯運行的基礎服務平臺。為形成一體化應用、保證系統的可維護性和可擴展性奠定基礎。
應用平臺層包括統一用戶平臺、統一資源管理平臺、數據交換平臺、互動社區平臺、移動學習平臺、在線互動教學平臺和簡訊服務平臺。
2.1.3數據資源層
數據資源層構成應用系統層、應用平臺層的數據支撐環境。包括基礎類資料庫、應用類資料庫和課件類資料庫。
另外,安全管理體系與維護支持系統貫穿應用系統層、應用平臺層、數據資源層的各個層面,為邏輯架構中各層提供安全管理、系統監控和維護支持等服務功能。當然,不同層面服務內容不盡相同。
統一、完整的總體應用架構清晰的劃分了系統的邏輯層次,各層次相對獨立,從而簡化了系統複雜度,保證系統滿足建設要求。第三章
第三章 模塊詳細設計
3.1主學習流程
3.2門戶系統詳細設計
3.2.1核心結構和功能分配
3.2.2核心頁面流轉圖
3.2.3核心功能模塊設計
3.2.3.1門戶通知通告調用功能
ü門戶調用連接:listTztgForPortal.action、listMoreTztgForPortal.action
ü內容展示頁面:includeTztg.jsp、includeMoreTztg.jsp
üAction類文件名:ListTztgAction.java、ListMoreTztgAction.java
üListTztgAction.java中主要實現方法:
使用ManagersFactory創建IDynamicManager管理類實例dynamicManager。調用dynamicManager對象中getStudyDynamicDetailSeq(newInteger(3))方法,獲得通知通告列表。創建DateFormat對象實例dataFormat,按照yyyy/MM/dd格式對通知通告中的時間進行格式化。將通知通告列表通過request傳給內容展示頁面,在頁面中循環輸出每條通知通告。調用dynamicManager中getCommentator()得到公告,將公告傳回頁面並在通知通告上方顯示。
第四章 全局數據結構說明
參考《在線學習系統資料庫設計說明書》
第五章 核心程序和算法設計
5.1平臺(Plat)設計說明
5.1.1數據結構說明
本模塊數據結構名稱為PlatForm,主要功能包括定義相應數據欄位以及對這些數據的存取方法;
5.1.2算法及流程
算法:平臺操作
輸入:一個事件代號,event,整型
輸出:
過程:
switch (event) {
case INSERT:
執行將數據存儲到資料庫的方發調用;
break;
case UPDATE:
執行將所選數據更新到資料庫的方法調用;
break;
case DELETE:
執行將所選數據從資料庫刪除的操作;
break;
case QUERY:
執行按照所填寫的查詢條件查詢數據的過程調用;
break;
case SHOWDATA:
執行將所有數據全部顯示的方法調用;
break;
case SHOWRECORD:
執行將所選某條數據詳細信息全部顯示的方法調用
break;
}
5.1.3數據存儲說明
無。
5.1.4源程序文件說明
源程序文件名稱為:PlatForm.java, PlatCommand.java, PlatAction.java;
目錄為:src\java\com\user\manage\platmanage;
主要執行關於平臺的增、刪、改、查以及瀏覽等操作;
5.1.5函數說明
本程序主要函數包括:
1、insert():功能為新增一條新平臺;
2、update():功能為更新某條所選平臺的基本信息;
3、delete():功能為將某個平臺狀態欄位設為0,不做屋裡刪除;
4、query():根據條件查詢數據;
5、showdata():將所有平臺信息取出來以供瀏覽
6、initForm():設置頁面某些基本信息,如設置LableValueBean;
7、showRecord():按條件取出某條信息,以對該條信息進行詳細瀏覽;
8、clear():清空表單信息。
-作者-
李鵬星,一隻愛碼字的IT老鳥,從程式設計師一路成長,一心夢想工作自由,財富自由的80後。