軟件系統(tǒng)設(shè)計報告模板

1、 項目名稱軟件系統(tǒng)設(shè)計報告姓名：姓名：學(xué)號：學(xué)號：班級：班級：日期：日期：目錄0.文檔說明文檔說明.10.1設(shè)計文檔的目的和文檔使用范圍；.10.2文檔的讀者；.10.3參考資料；.10.4縮略語；.11.系統(tǒng)概述系統(tǒng)概述.21.1系統(tǒng)部署圖.21.2硬件環(huán)境.21.3軟件環(huán)境.31.3.1OS 環(huán)境.31.3.2依賴軟件.31.3.3開發(fā)環(huán)境.31.4系統(tǒng)安裝.31.5系統(tǒng)啟動.41.6系統(tǒng)退出.42.關(guān)鍵技術(shù)關(guān)鍵技術(shù).52.1技術(shù)點描述.52.1.1XXX1 技術(shù)點.52.1.2XXX2 技術(shù)點.52.2關(guān)鍵算法描述.52.2.1YYY1 關(guān)鍵算法.52.2.2YYY2 關(guān)鍵算法.63.結(jié)

2、構(gòu)設(shè)計結(jié)構(gòu)設(shè)計.73.1軟件架構(gòu)圖.73.2模塊關(guān)系圖.93.3模塊功能說明.93.4系統(tǒng)的初始化、退出描述.93.5系統(tǒng)狀態(tài)圖.114.并發(fā)設(shè)計并發(fā)設(shè)計.134.1線程結(jié)構(gòu).135.模塊內(nèi)設(shè)計模塊內(nèi)設(shè)計.155.1XX 模塊設(shè)計.155.1.1類的關(guān)系圖.155.1.2類的說明.155.1.3接口說明.165.1.4算法描述.165.2YY 模塊設(shè)計.16 第 1 頁0. 文檔說明文檔說明0.1 設(shè)計文檔的目的和文檔使用范圍；設(shè)計文檔的目的和文檔使用范圍；簡要描述這個文檔的編寫目的和使用范圍。正文。0.2 文檔的讀者；文檔的讀者；描述這個文檔的讀者。正文。0.3 參考資料；參考資料；與本設(shè)計

3、相關(guān)的資料。一般是指設(shè)計依據(jù)的資料。如：編號編號相關(guān)文檔相關(guān)文檔1UniMed4.0系統(tǒng)框架設(shè)計報告.doc2表格 1 參考資料0.4 縮略語；縮略語；定義重要的術(shù)語、縮寫詞 或縮略語；縮略語、術(shù)語縮略語、術(shù)語全稱、解釋全稱、解釋表格 2 縮略語 第 2 頁1. 系統(tǒng)概述系統(tǒng)概述主要從系統(tǒng)需求的角度，描述系統(tǒng)；描述的輸入是用戶需求（式樣） 。正文。1.1 系統(tǒng)部署圖系統(tǒng)部署圖給出系統(tǒng)部署圖，并進(jìn)行簡要說明。使用 Visio 描畫，表示方法參見圖例。圖例參見：Microsoft Word 文檔例圖如下：軟件AAUSB 設(shè)備MPC機OSPC Domain軟件BB軟件XX軟件AASServer機OS

4、ServerSH數(shù)據(jù)設(shè)計對象外部模塊硬件說明：圖 1 系統(tǒng)部署圖下面應(yīng)該對部署圖進(jìn)行說明。正文。1.2 硬件環(huán)境硬件環(huán)境描述系統(tǒng)的硬件環(huán)境：以及對系統(tǒng)有影響的關(guān)鍵硬件信息。硬件名稱硬件名稱基本要求基本要求推薦配置推薦配置CPU1G Pentium1.6G Pentium硬盤硬盤20G40G內(nèi)存內(nèi)存512M1G顯卡顯卡 第 3 頁顯示器顯示器其它其它表格 3 系統(tǒng)關(guān)鍵硬件信息正文。1.3 軟件環(huán)境軟件環(huán)境描述系統(tǒng)的軟件環(huán)境：OS、以及對系統(tǒng)正常工作提供支持的所有軟件對象（如 3D 的插件等） ；以及使用到的第三方接口。1.3.1OS 環(huán)境環(huán)境說明操作系統(tǒng)及其版本號。系統(tǒng)名稱系統(tǒng)名稱版本號版本號提

5、供商提供商表格 4 OS 環(huán)境1.3.2依賴軟件依賴軟件說明依賴軟件、組件、服務(wù)信息。軟件名稱軟件名稱版本號版本號提供商提供商備注備注表格 5 依賴軟件1.3.3開發(fā)環(huán)境開發(fā)環(huán)境說明開發(fā)工具等信息。軟件名稱軟件名稱版本號版本號使用語言使用語言提供商提供商備注備注Visual S2005C+Microsoft表格 6 開發(fā)環(huán)境1.4 系統(tǒng)安裝系統(tǒng)安裝描述對系統(tǒng)安裝方法/方式的考慮，如提供那些安裝方法/方式。正文。 第 4 頁1.5 系統(tǒng)啟動系統(tǒng)啟動描述系統(tǒng)啟動的操作步驟。正文。1.6 系統(tǒng)退出系統(tǒng)退出描述系統(tǒng)退出的操作步驟。正文。 第 5 頁2. 關(guān)鍵技術(shù)關(guān)鍵技術(shù)描述采用的新技術(shù)、新的技術(shù)方向（

6、如 VOIP） ，以及可能帶來的風(fēng)險或技術(shù)難點。先應(yīng)該描述技術(shù)點（表）和關(guān)鍵算法（表） 。然后對每個技術(shù)點和算法進(jìn)行描述。技術(shù)點列表如下：編號編號技術(shù)點略稱技術(shù)點略稱狀態(tài)狀態(tài)No.1XXX1No.2XXX2表格 7 技術(shù)點列表狀態(tài)包括：掌握、了解、了解中；用于跟蹤是否存在風(fēng)險。關(guān)鍵算法列表如下：編號編號算法略稱算法略稱備注備注No.1YYY1No.2YYY2表格 8 關(guān)鍵算法列表2.1 技術(shù)點描述技術(shù)點描述逐個對技術(shù)點進(jìn)行描述。描述每個技術(shù)點的內(nèi)容、解決方法 、狀態(tài)等。正文。2.1.1XXX1 技術(shù)點技術(shù)點正文。2.1.2XXX2 技術(shù)點技術(shù)點正文。2.2 關(guān)鍵算法描述關(guān)鍵算法描述逐個對關(guān)鍵算

7、法進(jìn)行描述。對每個算法進(jìn)行詳細(xì)說明。2.2.1YYY1 關(guān)鍵算法關(guān)鍵算法正文。 第 6 頁2.2.2YYY2 關(guān)鍵算法關(guān)鍵算法正文。 第 7 頁3. 結(jié)構(gòu)設(shè)計結(jié)構(gòu)設(shè)計3.1 軟件架構(gòu)圖軟件架構(gòu)圖描述系統(tǒng)的軟件架構(gòu)圖，并對圖中的模塊進(jìn)行說明。使用 UML 的包圖或 Visio 圖描述軟件架構(gòu)圖，軟件架構(gòu)圖的描述方法參照圖例。軟件架構(gòu)圖主要體現(xiàn)系統(tǒng)的內(nèi)部架構(gòu)，及與外部的關(guān)系。內(nèi)部重點描述模塊組成（層次）關(guān)系，對于小系統(tǒng)，一般架構(gòu)圖就可以描述全部模塊的關(guān)系，因此也就不需要后續(xù)的模塊關(guān)系圖。如果系統(tǒng)比較大，此處可以只畫出系統(tǒng)中的一級模塊，更詳細(xì)的結(jié)構(gòu)在后面的模塊關(guān)系圖中描述。與外部的關(guān)系，主要表達(dá)與那

8、些外部對象進(jìn)行交互，以及如何與外部進(jìn)行交互的。例圖如下： 第 8 頁數(shù)數(shù)據(jù)據(jù)訪訪問問層層業(yè)業(yè)務(wù)務(wù)邏邏輯輯層層表表現(xiàn)現(xiàn)層層InterfaceBusiProcessorDataFacadeMemoryManagerDBUIControlerDBInterfaceFileHandlerCheckVersionCommonUtilsFileStoreSMS DBIDEManagerDBAdapter外部模塊說明：新規(guī)模塊圖 2 軟件架構(gòu)圖以下對軟件架構(gòu)圖進(jìn)行描述。正文。 第 9 頁3.2 模塊關(guān)系圖模塊關(guān)系圖請畫出模塊關(guān)系圖。使用包圖描述，模塊關(guān)系圖的描述方法參照軟件架構(gòu)圖的圖例。模塊關(guān)系圖主要體現(xiàn)系

9、統(tǒng)的內(nèi)部架構(gòu)。重點描述模塊組成（層次）關(guān)系，對于小系統(tǒng)，一般架構(gòu)圖就可以描述全部模塊的關(guān)系，因此也就不需要模塊關(guān)系圖。根據(jù)需要，模塊關(guān)系圖中的某個（些）模塊還可以放大，進(jìn)行更進(jìn)一步的描述。正文。3.3 模塊功能說明模塊功能說明請參照模塊關(guān)系圖，將各個模塊功能進(jìn)行詳細(xì)說明。如,No模塊名稱模塊名稱概述概述1Interface此模塊主要負(fù)責(zé)對 xml 文件進(jìn)行修改，添加命令行，以及執(zhí)行 xml 文件等操作2Navigator負(fù)責(zé) xml 命令的解析與執(zhí)行3Control腳本 API 的功能實現(xiàn)模塊，被 Navigator 模塊調(diào)用45678910113.4 系統(tǒng)的初始化、退出描述系統(tǒng)的初始化、退出

10、描述請使用時序圖描述系統(tǒng)初始化、退出的處理過程。使用 Rose 或 Visio 描述時序圖，描述方法參照圖例。時序圖的對象應(yīng)該是對象或者模塊。 第 10 頁系統(tǒng)初始化時序圖的一個例子如下：AcaAbaAaaInitializeInitRead RegistryOther ActionsInitInit Matrix圖 3 系統(tǒng)初始化時序正文。系統(tǒng)退出的時序圖如下：AcaAbaAaaFree ResourceExit PrepareFree ResourceExit TaskExit PrepareFree Resource圖 4 系統(tǒng)退出時序正文。 第 11 頁3.5 系統(tǒng)狀態(tài)圖系統(tǒng)狀態(tài)圖描述

11、系統(tǒng)的狀態(tài)圖。狀態(tài)圖描述方法參照圖例。Microsoft Word 文檔不是所有系統(tǒng)都有狀態(tài)圖，但對于有明顯狀態(tài)變化的系統(tǒng)（例如復(fù)雜的畫面遷移）需要描述狀態(tài)圖。如果狀態(tài)圖不足以描述，可以增加狀態(tài)遷移表進(jìn)行補充。例圖如下： Wait IniNormaFCP Comm ErrorIdleFCPInitFCPInitFCPCommOKFCPCommErrTimeoutInitRootMenuFCPCommErrService TerminateService TerminateService TerminateService Terminate復(fù)合狀態(tài)1圖 5 系統(tǒng)狀態(tài)圖狀態(tài)圖說明列表：FromTo

12、事件行為 第 12 頁StartWait InitAPPMgr 啟動如 FCPMgr 通訊正常，每隔 10 秒要一次初始化信息。Wait InitNormal接收到FCPInit 包根據(jù)屏幕初始化設(shè)備信息、初始化 AppCtrl 和MsgBoxCtrl、啟動 ADMgr、RollMgr。向應(yīng)用派發(fā)狀態(tài)改變事件。表格 9 狀態(tài)遷移表 第 13 頁4. 并發(fā)設(shè)計并發(fā)設(shè)計4.1 線程結(jié)構(gòu)線程結(jié)構(gòu)描述線程的組成、線程之間的關(guān)系、線程與模塊關(guān)系。使用線程關(guān)系圖描述線程關(guān)系、通過模塊線程關(guān)系圖描述線程的部署。圖例參見：Microsoft Word 文檔1線程組成：通過線程列表，對線程的職責(zé)、生命周期進(jìn)行說

13、明；No.線程名職責(zé)生命周期1Aca1.全局2Aca2.全局3Aca4.全局表格 10 線程列表2線程關(guān)系。Aca1 ThreadAca2 ThreadMsgQAca4 ThreadMsgQMsgQ圖 6 線程關(guān)系圖 第 14 頁3線程與模塊關(guān)系。AcaAca2Aca3Aca4Aca1Aca5Aca6111圖 7 線程與模塊關(guān)系圖需要使用文字描述線程與模塊的關(guān)系，一個模塊有那個（些）線程。如 Aca1 模塊中有 Aca1 線程、Aca2 模塊中有 Aca2 線程、Aca5 模塊中有 Aca5 線程。正文。 第 15 頁5. 模塊內(nèi)設(shè)計模塊內(nèi)設(shè)計識別出模塊的數(shù)據(jù)結(jié)構(gòu)-Class，以及 Class

14、 之間的關(guān)系，并根據(jù)需要，描述狀態(tài)轉(zhuǎn)化圖、算法描述、主要數(shù)據(jù)結(jié)構(gòu)等關(guān)鍵技術(shù)細(xì)節(jié)。5.1 XX 模塊設(shè)計模塊設(shè)計5.1.1類的關(guān)系圖類的關(guān)系圖請描述類圖，描述方法參見圖例： C CD DB BF Fa ac cd de eC CM Me em mo or ry yM Ma an na ag ge er rC CS St ta ac ck kC CA Ar rr ra ay yL Li is st tS St ta ac ck k1111C CB Ba as se eC Ch he ec ck kV Ve er rs si io on nC CC Ch he ec ck kR Re eg gV V

15、e er rs si io on nC CC Ch he ec ck kT Tx xt tV Ve er rs si io on nC CC Ch he ec ck kE Ex xe eO Or rD Dl ll lV Ve er rs si io on nC CC Co om mm mo on nU Ut ti il ls s11111111C CB Bu us si iP Pr ro oc ce es ss so or rC CD DB BU UI IF Fo or rm m1*11C CC Co on nt tr ro ol lF Fo or rm m11圖 8 XX 模塊類關(guān)系圖5.1

16、.2類的說明類的說明將類圖提及的類的功能進(jìn)行說明。Class ListNo.Class NameDescription1MForm生成初始運行界面2CFindDlg查找類（起到查找字符串功能）3CAboutBox用于顯示 About 對話框4CStringTable備用5CSettingsDlg備用 第 16 頁正文。5.1.3接口說明接口說明列出子模塊對外的宏定義、類型定義、枚舉定義、結(jié)構(gòu)體和聯(lián)合體定義。說明子模塊對外的函數(shù)。正文。XXX 接口InterFace SpecificationNameCopyBuild()Interface Description從 FileStore 上下載腳

17、本中指定的 part type 版本目錄到指定目錄下。PrototypeCOPYBUILD_EXPORT bool CopyBuild(const TCHAR* buildScript, const TCHAR* partType, const TCHAR* installType, const TCHAR* filestore, const TCHAR* destination)NameTypeIODescriptionbuildScriptconst TCHAR*IBuild 腳本的路徑。partTypeconst TCHAR*IpartType 類型對應(yīng)的值，如1（ANY）installTypeconst TCHAR*IIn