系統(tǒng)概要設(shè)計(jì)說明書范例

概要設(shè)計(jì)說明書引言編寫目的【闡明編寫概要設(shè)計(jì)說明書的目的，指明讀者對象?！勘疚臋n的編寫目的是根據(jù)項(xiàng)目需求說明書，闡述系統(tǒng)結(jié)構(gòu)，數(shù)據(jù)定義，接口設(shè)計(jì)等內(nèi)容…【展開補(bǔ)充】項(xiàng)目背景應(yīng)包括●項(xiàng)目的委托單位、開發(fā)單位和主管部門●該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。定義列出本文檔中所用到的專門術(shù)語的定義和縮寫詞的愿意。參考資料：●列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源●項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級機(jī)關(guān)的批文；項(xiàng)目開發(fā)計(jì)劃；需求規(guī)格說明書；測試計(jì)劃（初稿）；用戶操作手冊●文檔所引用的資料、采用的標(biāo)準(zhǔn)或規(guī)范。任務(wù)概述目標(biāo)【系統(tǒng)目標(biāo)的描述，系統(tǒng)將要為用戶提供什么樣的服務(wù)，將文字補(bǔ)充豐富】系統(tǒng)將為三種角色用戶提供服務(wù)，分別是老師、管理員、學(xué)生。將系統(tǒng)需要的功能按照三種角色要求可歸納為下圖的功能結(jié)構(gòu)圖：在上面的功能結(jié)構(gòu)圖中，其中老師模塊實(shí)現(xiàn)的功能包括：教師可以進(jìn)入系統(tǒng)修改自己的資料。教師可查看別的老師申報(bào)的課題。教師可以申報(bào)畢設(shè)課題。教師可以篩選學(xué)生填報(bào)的本人的志愿。管理員模塊的功能：管理員可以進(jìn)入系統(tǒng)審核教師申報(bào)的課題，并且將審核通過的課題向?qū)W生開放，將審核未過的課題退回教師重新修改。在教師學(xué)生互選過程進(jìn)行到一定時(shí)間階段，管理員可以將未選課題和未定題學(xué)生進(jìn)行隨機(jī)匹配。管理員可以對選題結(jié)果進(jìn)行統(tǒng)計(jì)生成報(bào)表，并將報(bào)表通過教務(wù)系統(tǒng)開放接口提交。學(xué)生模塊的功能：學(xué)生可以進(jìn)入系統(tǒng)瀏覽搜索查看已向?qū)W生開放的課題。學(xué)生可以選擇專業(yè)對口的課題進(jìn)行收藏。學(xué)生可以從收藏的課題中填報(bào)10個(gè)課題志愿。學(xué)生可以查看選題狀態(tài)和結(jié)果。需求分析【用例分析的結(jié)果（用例圖和用例描述）】根據(jù)上面需要實(shí)現(xiàn)的系統(tǒng)目標(biāo)，可以畫出以下用例圖表達(dá)：對用例圖中各業(yè)務(wù)用例，說明如下：申報(bào)課題目標(biāo)本用例的目標(biāo)是由教師填寫課題相關(guān)信息申報(bào)課題。事件流教師申報(bào)課題的基本業(yè)務(wù)流程如下：由教師填寫課題資料，資料包括：課題編號、課題名稱、課題類型、課題面向?qū)I(yè)、課題工作內(nèi)容、課題對學(xué)生要求。教師提交課題，通過數(shù)據(jù)驗(yàn)證后，將合格的課題提交到課題數(shù)據(jù)庫（數(shù)據(jù)文件）中，將驗(yàn)證不合格課題返回修改。向用戶輸出提示信息現(xiàn)實(shí)操作結(jié)果。特殊需求本操作必須由教師身份的用戶執(zhí)行。前置條件操作之前，教師必須使用用戶名密碼登錄。后置條件篩選志愿目標(biāo)本用例由教師選擇自己所出課題的畢設(shè)學(xué)生。事件流教師篩選志愿的基本業(yè)務(wù)流程如下：教師查看所屬課題的志愿選擇狀態(tài)和統(tǒng)計(jì)，包括：每個(gè)課題的當(dāng)前狀態(tài)（開放和關(guān)閉），選擇當(dāng)前課題的所有志愿，選擇當(dāng)前課題的學(xué)生狀態(tài)。教師從選擇課題的志愿中，選取一個(gè)狀態(tài)為尚未定題的學(xué)生，確定其為當(dāng)前課題選題人。將課題與選題人提交，寫入數(shù)據(jù)庫（數(shù)據(jù)文件）。修改課題狀態(tài)為已選關(guān)閉，修改填寫本課題的其它志愿狀態(tài)為落選。修改本課題選題人的當(dāng)前志愿為中選，修改選題人的其它志愿為自動(dòng)取消。特殊需求本操作必須由教師身份的用戶執(zhí)行。前置條件操作之前，教師必須使用用戶名密碼登錄。篩選志愿的課題必須處于開放狀態(tài)。被選學(xué)生必須填報(bào)了該課題志愿，并且學(xué)生狀態(tài)為未選定課題。后置條件條件與限制總體設(shè)計(jì)根據(jù)用例分析中系統(tǒng)功能需求，系統(tǒng)整體業(yè)務(wù)流程如下（活動(dòng)圖）：【根據(jù)用例分析中的功能需求，組織我們的業(yè)務(wù)流程】系統(tǒng)業(yè)務(wù)分成三個(gè)模塊實(shí)現(xiàn)，如下圖（包圖）所示：教師模塊根據(jù)教師模塊功能，教師模塊所包含的類有：教師類教師記錄操作教師申報(bào)界面類（對應(yīng)的需求說明中界面流程設(shè)計(jì)）教師篩選界面類類圖：模塊主要業(yè)務(wù)描述（時(shí)序圖或活動(dòng)圖）學(xué)生模塊管理員模塊類抽象類圖管理員模塊的主要業(yè)務(wù)：（時(shí)序圖，或者活動(dòng)圖）整體結(jié)構(gòu)【對模塊的設(shè)計(jì)進(jìn)行整合】系統(tǒng)類的抽象類圖的優(yōu)化合并各功能操作類根據(jù)層次原則組成整體系統(tǒng)結(jié)構(gòu)?！緩拇怪狈较?qū)⑾到y(tǒng)結(jié)構(gòu)按照功能劃分，然后在水平方向按照層次結(jié)構(gòu)合并和組合同一層次的模塊（包）或類，形成一個(gè)垂直劃分和水平劃分相結(jié)合的體系結(jié)構(gòu)?！俊究梢允且粋€(gè)包圖，由于設(shè)計(jì)時(shí)分的不夠詳細(xì)，用方框表示】數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)從需求說明書中表態(tài)數(shù)據(jù)、動(dòng)態(tài)數(shù)據(jù)、數(shù)據(jù)詞典形成規(guī)范的數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)表結(jié)構(gòu)數(shù)據(jù)庫的定義規(guī)則字段類型約束描述備注nameVarhcar(120)Notnull姓名教師表（Teachers）字段類型約束描述備注TIDVARCHAR(20)NOTNULL教師工號主鍵nameVarhcar(120)Notnull姓名DEPARTVARCHAR(20)系COLLEGE學(xué)院學(xué)生表(STUDENTS)字段類型約束描述備注SIDVARCHAR(20)NOTNULL學(xué)號主鍵nameVarhcar(120)Notnull姓名DEPARTVARCHAR(20)系COLLEGE學(xué)院數(shù)據(jù)文件教師信息文件工號，姓名，學(xué)院，系，專業(yè)，教授課程；00001111，張三，信息學(xué)院，電子信息，軟件工程；00001112，李四，建設(shè)學(xué)院，土木工程，橋梁；學(xué)生信息文件管理員文件課題文件志愿文件數(shù)據(jù)文件名：ini配置格式[配置節(jié)]配置項(xiàng)名=配置項(xiàng)值Xml教師信息文件<teachers><teacher> <tid/> <name/> <college/> <depart/> <courses/></teacher><teacher> <tid/> <name/> <college/> <depart/> <courses/></teacher></teachers>學(xué)生信息文件管理員文件課題文件志愿文件ini配置文件[節(jié)點(diǎn)]key=value動(dòng)態(tài)數(shù)據(jù)https://動(dòng)態(tài)交易密鑰功能模塊設(shè)計(jì)外部接口：【包括用戶界面、軟件接口與硬件接口。】與教務(wù)系統(tǒng)提交選題統(tǒng)計(jì)報(bào)表寫明如何使用此外部接口內(nèi)部接口（模塊）由系統(tǒng)整體結(jié)構(gòu)圖（系統(tǒng)類圖）從垂直或水平方向的模塊劃分來設(shè)計(jì)模塊。教師類(Teacher)課題申報(bào)+/-/#intProjectApply(stringprjname,stringprjmajor,stringprjdesc,stringprjdemand…)輸入?yún)?shù)分析輸出返回結(jié)果處理處理流程，復(fù)雜業(yè)務(wù)可使用時(shí)序圖約束志愿篩選intAppSelect(string,int,….)輸入?yún)?shù)分析輸出返回結(jié)果處理處理流程，復(fù)雜業(yè)務(wù)可使用時(shí)序圖約束課題類(Project)做課題類分析時(shí)，可以為課題類建立狀態(tài)圖。課題添加intAdd(….)輸入?yún)?shù)分析輸出返回結(jié)果處理處理流程，復(fù)雜業(yè)務(wù)可使用時(shí)序圖約束課題開放intOpen(username,projectid)輸入?yún)?shù)分析輸出返回結(jié)果處理處理流程，復(fù)雜業(yè)務(wù)可使用時(shí)序圖約束課題關(guān)閉intClose()輸入?yún)?shù)分析輸出返回結(jié)果處理處