18-系統(tǒng)設(shè)計說明書

XXX項目18系統(tǒng)設(shè)計說明書編制單位：XXX有限公司編制時間：2020年4月20日XXX項目系統(tǒng)設(shè)計說明書目錄1 引言 11.1 編寫目的 11.2 術(shù)語和縮略語 11.3 參考資料 12 環(huán)境與工具 23 總體設(shè)計 23.1 設(shè)計原則 33.2 設(shè)計依據(jù) 33.3 系統(tǒng)總體架構(gòu) 33.4 系統(tǒng)功能結(jié)構(gòu) 43.5 設(shè)計策略與方法 53.6 系統(tǒng)功能大綱 63.7 系統(tǒng)部署結(jié)構(gòu) 64 子系統(tǒng)/模塊設(shè)計 74.1 子系統(tǒng)/子模塊1 74.2 子系統(tǒng)/子模塊2 94.3 子系統(tǒng)/子模塊XXX 95 數(shù)據(jù)庫設(shè)計 95.1 數(shù)據(jù)庫的命名規(guī)則 95.2 數(shù)據(jù)庫概念模型 95.3 表設(shè)計 105.4 存儲過程/包設(shè)計 116 接口設(shè)計 146.1 外部接口設(shè)計 146.2 內(nèi)部接口設(shè)計 147 系統(tǒng)非功能設(shè)計 147.1 性能設(shè)計 157.2 界面設(shè)計 157.3 安全設(shè)計 16引言編寫目的 〔說明編寫系統(tǒng)設(shè)計說明書的目的，指出預期讀者?！呈纠罕疚臋n是XXX公司的軟件設(shè)計師根據(jù)本公司已編寫的有關(guān)需求，在分別與軟件使用者和軟件開發(fā)工程師進行了較為深入地探討和分析的基礎(chǔ)上編寫的，主要目的是用于指導《XXX項目》的軟件開發(fā)、測試及未來維護工作。本文檔預期讀者為軟件設(shè)計決策人員、開發(fā)人員、測試人員等?！g(shù)語和縮略語〔說明本文檔的術(shù)語和縮略語，并加以解釋。〕示例：生命周期模型：描述軟件開發(fā)的組織方式、步驟的模型，稱為軟件生命周期模型。QA：質(zhì)量保證(QualityAssurance)；CM:配置管理(ConfigurationManagement)；……參考資料〔列出與本文檔有關(guān)的參考資料?！呈纠骸冻醪皆O(shè)計方案》；《需求規(guī)格說明書》；……環(huán)境與工具〔描述本系統(tǒng)中所涉及的軟、硬件運行環(huán)境和系統(tǒng)設(shè)計工具。〕示例：1、系統(tǒng)運行環(huán)境硬件環(huán)境:CPU：P43.0G以上；內(nèi)存：1GB以上；硬盤：硬盤80G。軟件環(huán)境:數(shù)據(jù)庫：Oracle10g；應用服務器：Tomcat5.5應用服務器軟件；JDK版本：JDK1.4操作系統(tǒng)：WindowsXP及以上2、系統(tǒng)設(shè)計工具數(shù)據(jù)庫設(shè)計的工具：PowerDesigner……總體設(shè)計〔描述總體設(shè)計中設(shè)計原則、設(shè)計依據(jù)、系統(tǒng)總體架構(gòu)、系統(tǒng)功能結(jié)構(gòu)、設(shè)計策略與方法、系統(tǒng)功能大綱、系統(tǒng)部署結(jié)構(gòu)等?！吃O(shè)計原則〔描述總體設(shè)計中的原則?！呈纠?.整體性與開放性的原則，在本項目系統(tǒng)設(shè)計時應當充分考慮各業(yè)務系統(tǒng)之間的關(guān)系，整體設(shè)計規(guī)劃本項目系統(tǒng)，注重各種信息資源的有機整合，既考慮整體性，同時也要具有一定的開放性。2.可擴展性和易維護性的原則，在設(shè)計時應具有一定的前瞻性，充分考慮系統(tǒng)升級、擴容、擴充和維護的可行性；并針對本系統(tǒng)涉及用戶多、業(yè)務繁雜的特點，充分考慮如何大幅度提高業(yè)務處理的響應速度以及統(tǒng)計匯總的速度和精度……設(shè)計依據(jù)〔描述總體設(shè)計中的依據(jù)標準?！呈纠骸队嬎銠C軟件文檔編制規(guī)范》GB-T8567-2006；……系統(tǒng)總體架構(gòu)〔給出系統(tǒng)總體結(jié)構(gòu)圖并進行簡要說明?！呈纠簣D3-1XX如圖3-1所示中間業(yè)務處理層通過API接口與業(yè)務對象BO與數(shù)據(jù)代理DP連接實現(xiàn)對數(shù)據(jù)庫的查詢操作和外部系統(tǒng)和通用服務的連接。講查詢結(jié)果按功能模塊處理后，通過API接口交給應用界面顯示給用戶?！到y(tǒng)功能結(jié)構(gòu)〔詳細描述總體設(shè)計中系統(tǒng)功能的各個模塊以及子模塊的結(jié)構(gòu)，并附系統(tǒng)功能結(jié)構(gòu)圖?！呈纠焊鶕?jù)本項目的建設(shè)需求，對學生職業(yè)生涯培養(yǎng)系統(tǒng)、平板互動教學平臺、課題互動平臺、課件制作平臺以及試卷題庫管理生成系統(tǒng)的建設(shè)系統(tǒng)，每個系統(tǒng)下面具有子功能我的生涯規(guī)劃、認識專業(yè)、生涯規(guī)劃管理員操作、課程建立、微課堂、學生統(tǒng)計、學生管理、課程管理、白板互動、課堂作業(yè)、互動活動、教材與編目管理、教學進度管理、主備文檔模板管理評課、在線組卷、私人題庫、發(fā)布測驗、答題情況等具體結(jié)構(gòu)如圖3-2圖3-2XX設(shè)計策略與方法〔描述系統(tǒng)設(shè)計為滿足系統(tǒng)架構(gòu)所需使用的策略和方法?！呈纠簲U展策略：首先采用了B/S開發(fā)架構(gòu)，便于將來維護，同時也便于與其他相關(guān)系統(tǒng)互通。具體業(yè)務中增加了底層的數(shù)據(jù)維護功能，便于業(yè)務自身的擴展。折衷策略：本系統(tǒng)在習慣性和統(tǒng)一規(guī)范管理之間采取一定的折衷處理，考慮到學校老師習慣等原因，在操作界面上和操作流程上重點考慮接近現(xiàn)實流程。本系統(tǒng)在性能和安全上進行折衷處理，保證性能的前提下，重點以系統(tǒng)安全為主。設(shè)計方法：經(jīng)過系統(tǒng)分析，設(shè)計中采用原形法，針對相同類似功能采用原形與設(shè)計重用，具體設(shè)計過程中采用面向?qū)ο笤O(shè)計?！到y(tǒng)功能大綱〔以列表的形式描述系統(tǒng)功能的編號、名稱和功能概要?！呈纠罕?-1模塊編號模塊/功能名稱功能概要MC學生職業(yè)生涯培養(yǎng)系統(tǒng)主模塊MC01我的生涯規(guī)劃在“我的生涯規(guī)劃”“自我分析”頁面，學生可根據(jù)自己的性格、興趣、價值觀和能力等等方面，進行自我分析；在“長期目標”頁面，學生可對自己的職業(yè)目標和專業(yè)目標進行規(guī)劃，填寫目標內(nèi)容后；在“我的榜樣人物”頁面，學生可添加多個自己的榜樣人物，并且可以隨時對榜樣人物進行添加、修改、刪除等操作；在“短期目標”頁面，學生可根據(jù)高一/高二/高三目標進行歸納，包括目標內(nèi)容、學業(yè)發(fā)展計劃、綜合素質(zhì)提高計劃、身心發(fā)展計劃和其他成長足跡等；在“生涯規(guī)劃書”頁面，學生可對自己的生涯規(guī)劃書進行編輯和導出MC02認識專業(yè)在“認識專業(yè)”頁面，可對相關(guān)專業(yè)進行分類搜索，點擊“專業(yè)名稱”可查看該專業(yè)詳細內(nèi)容；點擊“開設(shè)院?！笨刹榭丛搶I(yè)開設(shè)院校。。MC03生涯規(guī)劃管理操作管理員進入生涯規(guī)劃，可對全校學生所創(chuàng)建的生涯規(guī)劃進行搜索、查看、導出等操作，其他操作均與學生一致。………………系統(tǒng)部署結(jié)構(gòu)〔描述系統(tǒng)服務器的總體部署情況?！呈纠簣D3-3XXXXX系統(tǒng)采用的是集中式的模式，集中部屬在中心集群上面。數(shù)據(jù)庫分兩類，運算數(shù)據(jù)庫和生產(chǎn)數(shù)據(jù)庫，數(shù)據(jù)庫集群上共有4個生產(chǎn)集群與4個運算集群?！酉到y(tǒng)/模塊設(shè)計子系統(tǒng)/子模塊1〔根據(jù)本項目的需求列出本系統(tǒng)的各模塊功能設(shè)計，包含功能概要、業(yè)務規(guī)模、界面設(shè)計、關(guān)鍵SQL語句等?！呈纠?.1.1功能概要功能概要說明：我的生涯規(guī)劃，是學生可根據(jù)自己的性格、興趣、價值觀和能力等等方面，進行自我分析；在“長期目標”頁面，學生可對自己的職業(yè)目標和專業(yè)目標進行規(guī)劃。4.1.2業(yè)務規(guī)模學校學生可以每半學期記錄制定一次自己的生涯規(guī)劃。4.1.3界面設(shè)計圖4-1界面構(gòu)造：標簽、BUTTON按鈕、列表控件、翻頁控件進入操作：學生職業(yè)生涯培養(yǎng)系統(tǒng)——我的生涯規(guī)劃——自我分析、長期目標、我的榜樣人物、短期目標體和生涯規(guī)劃書登陸后初始狀態(tài)：默認為我的生涯規(guī)劃界面頁面切換后狀態(tài)：顯示上次輸入值退出操作：切換模塊、退出系統(tǒng)、關(guān)閉瀏覽器4.1.4關(guān)鍵SQL語句SELECTEHR_HEAT_MAIN.HEAD_IDASHEAD_ID,(selectr.shortnamefrompub_depart_attachrwherer.depart_code=EHR_HEAT_MAIN.ORG_ID)ASORG_ID,EHR_HEAT_MAIN.YEAR_MONASYEAR_MON,to_char(EHR_HEAT_MAIN.ADD_TIME,'yyyy-mm-dd')ASADD_TIME,(selectt.user_namefrompub_manage_usertwheret.user_idcode=EHR_HEAT_MAIN.ADD_OPR_ID)ASADD_OPR_ID,to_char(EHR_HEAT_MAIN.LAST_CHG_TIME,'yyyy-mm-dd')ASLAST_CHG_TIME,EHR_HEAT_MAIN.LAST_CHG_OPR_IDASLAST_CHG_OPR_IDFROMEHR_HEAT_MAIN子系統(tǒng)/子模塊2……子系統(tǒng)/子模塊XXX……數(shù)據(jù)庫設(shè)計數(shù)據(jù)庫的命名規(guī)則〔闡述此數(shù)據(jù)庫設(shè)計說明書的數(shù)據(jù)庫命名規(guī)則?！呈纠?.1數(shù)據(jù)庫（database）命名規(guī)則數(shù)據(jù)庫名長度：不超過INFORMIX規(guī)定長度(十八位)；采用英文形式，規(guī)則如XXX；數(shù)據(jù)庫名由兩部分組成：系統(tǒng)名+DB；系統(tǒng)名由英文單詞構(gòu)成，每個單詞首字母大寫，單詞可采取縮寫形式；附表提供的詞根表作為構(gòu)詞的唯一依據(jù)?！瓟?shù)據(jù)庫概念模型〔用ER圖表示數(shù)據(jù)庫的概念模型。〕示例：圖5-1用戶通過登錄本系統(tǒng)進行線上咨詢，查詢、信息修改、意見反饋等操作，后臺收到修改信息，對用戶信息進行核實，根據(jù)修改信息的結(jié)果，進行再次確認，并把結(jié)果錄入檔案中。登錄本系統(tǒng)易于檔案進行工作量統(tǒng)計檔案管理和各種工作登記等。表設(shè)計示例：1）tc"表格BACKS_REASON_ALL的列清單"\l4表BACKS_REASON_ALL的列清單表5-1代碼數(shù)據(jù)類型注釋DD_IDVARCHAR2(20)DD_CODEVARCHAR2(20)DD_DESCVARCHAR2(100)DD_STATUSVARCHAR2(2)2）tc"表格BACKS_REASON_DOC的列清單"\l4表BACKS_REASON_DOC的列清單表5-2XX代碼數(shù)據(jù)類型注釋DD_IDVARCHAR2(20)DD_CODEVARCHAR2(20)DD_DESCVARCHAR2(100)DD_STATUSVARCHAR2(2)3)tc"表格BACKS_REASON_DOC的列清單"\l4表XXX的列清單存儲過程/包設(shè)計〔闡述數(shù)據(jù)庫存儲過程的設(shè)計，列出各個存儲過程對應的數(shù)據(jù)庫SQL語句〕示例:1.GenNewEhrNo表5-3XX名稱GenNewEhrNoSqlcreateorreplaceprocedureGenNewEhrNoisrow_dataehr_cli_registry%rowtype;cursorcur_ehrCliRegisselect*fromehr_cli_registrywhereadd_time>to_date('21-05-200610:05:00','DD-MM-YYYYHH24:MI:SS')orderbyss_id,status,add_time;temp_departCodevarchar2(50);temp_ehrTypevarchar2(10);v_generatorIdvarchar2(20);temp_countinteger;temp_count2integer;temp_indexinteger;str_indexvarchar2(20);temp_newnovarchar2(30);beginopencur_ehrCliReg;loopfetchcur_ehrCliRegintorow_data;exitwhencur_ehrCliReg%notfound;selectcount(*)intotemp_count2frompub_depart_info_sswheres.depart_code=row_data.ss_id;iftemp_count2=1thenselects.depart_indexintotemp_departCodefrompub_depart_info_sswheres.depart_code=row_data.ss_id;ifrow_data.status='00'thentemp_ehrType:='B';elsifrow_data.status='02'thentemp_ehrType:='A';elsifrow_data.status='01'thentemp_ehrType:='C';endif;selectcount(*)intotemp_countfromehr_newno_generatorgwhereg.depart_code=temp_departCodeandg.ehr_type=temp_ehrType;iftemp_count=1thenselectggg.currindexintotemp_indexfromehr_newno_generatorgggwhereggg.depart_code=temp_departCodeandggg.ehr_type=temp_ehrType;temp_index:=temp_index+1;updateehr_newno_generatorggsetgg.currindex=temp_indexwheregg.depart_code=temp_departCodeandgg.ehr_type=temp_ehrType;elseselectehr_reg_seq.nextvalintov_generatorIdfromdual;insertintoehr_newno_generator(generator_id,ehr_type,depart_code,currindex)values(v_generatorId,temp_ehrType,temp_departCode,1);temp_index:=1;endif;str_index:=to_char(temp_index);temp_newno:=temp_departCode||substr('000000',0,6-length(str_index))||str_index||'-'||temp_ehrType;updateehr_cli_registryehrsetehr.ehr_newno=temp_newnowhereehr.ehr_id=row_data.ehr_id;endif;endloop;closecur_ehrCliReg;endGenNewEhrNo;接口設(shè)計外部接口設(shè)計〔描述本系統(tǒng)的外部硬件接口設(shè)計，包括接口形式、輸入輸出參數(shù)、傳輸頻率等?！呈纠罕?-1編號系統(tǒng)接口形式輸入?yún)?shù)出口參數(shù)調(diào)用頻率1學生職業(yè)生涯培養(yǎng)Key系統(tǒng)USB端口InputOutput500次/天內(nèi)部接口設(shè)計〔描述本系統(tǒng)的內(nèi)部硬件接口設(shè)計，包括接口形式、輸入輸出參數(shù)以及調(diào)用頻率狀況等。〕示例：表6-2XX編號系統(tǒng)接口形式輸入?yún)?shù)出口參數(shù)調(diào)用頻率1登陸方式接口HCI用戶名、密碼用戶ID、角色、機構(gòu)500次/天系統(tǒng)非功能設(shè)計〔詳細描述系統(tǒng)的非功能性設(shè)計，包含并不限于以下內(nèi)容。〕性能設(shè)計〔從整體描述軟件在性能上需要達到的要求?！呈纠?、易用性統(tǒng)一的界面風格：方便用戶習慣操作。優(yōu)化頁面數(shù)據(jù)下載方式，適應不同帶寬的網(wǎng)絡(luò)訪問。（撥號、寬帶、GPRS訪問）清晰友好的在線幫助：使操作人員在短時間內(nèi)掌握系統(tǒng)的使用，并可以隨時獲取在線的指導。離線應用：由于