XXX項目18系統設計說明書編制單位：XXX有限公司編制時間：2020年4月20日XXX項目系統設計說明書目錄1 引言 11.1 編寫目的 11.2 術語和縮略語 11.3 參考資料 12 環境與工具 23 總體設計 23.1 設計原則 33.2 設計依據 33.3 系統總體架構 33.4 系統功能結構 43.5 設計策略與方法 53.6 系統功能大綱 63.7 系統部署結構 64 子系統/模塊設計 74.1 子系統/子模塊1 74.2 子系統/子模塊2 94.3 子系統/子模塊XXX 95 數據庫設計 95.1 數據庫的命名規則 95.2 數據庫概念模型 95.3 表設計 105.4 存儲過程/包設計 116 接口設計 146.1 外部接口設計 146.2 內部接口設計 147 系統非功能設計 147.1 性能設計 157.2 界面設計 157.3 安全設計 16引言編寫目的 〔說明編寫系統設計說明書的目的，指出預期讀者。〕示例：本文檔是XXX公司的軟件設計師根據本公司已編寫的有關需求，在分別與軟件使用者和軟件開發工程師進行了較為深入地探討和分析的基礎上編寫的，主要目的是用于指導《XXX項目》的軟件開發、測試及未來維護工作。本文檔預期讀者為軟件設計決策人員、開發人員、測試人員等。……術語和縮略語〔說明本文檔的術語和縮略語，并加以解釋。〕示例：生命周期模型：描述軟件開發的組織方式、步驟的模型，稱為軟件生命周期模型。QA：質量保證(QualityAssurance)；CM:配置管理(ConfigurationManagement)；……參考資料〔列出與本文檔有關的參考資料。〕示例：《初步設計方案》；《需求規格說明書》；……環境與工具〔描述本系統中所涉及的軟、硬件運行環境和系統設計工具。〕示例：1、系統運行環境硬件環境:CPU：P43.0G以上；內存：1GB以上；硬盤：硬盤80G。軟件環境:數據庫：Oracle10g；應用服務器：Tomcat5.5應用服務器軟件；JDK版本：JDK1.4操作系統：WindowsXP及以上2、系統設計工具數據庫設計的工具：PowerDesigner……總體設計〔描述總體設計中設計原則、設計依據、系統總體架構、系統功能結構、設計策略與方法、系統功能大綱、系統部署結構等。〕設計原則〔描述總體設計中的原則。〕示例：1.整體性與開放性的原則，在本項目系統設計時應當充分考慮各業務系統之間的關系，整體設計規劃本項目系統，注重各種信息資源的有機整合，既考慮整體性，同時也要具有一定的開放性。2.可擴展性和易維護性的原則，在設計時應具有一定的前瞻性，充分考慮系統升級、擴容、擴充和維護的可行性；并針對本系統涉及用戶多、業務繁雜的特點，充分考慮如何大幅度提高業務處理的響應速度以及統計匯總的速度和精度……設計依據〔描述總體設計中的依據標準。〕示例：《計算機軟件文檔編制規范》GB-T8567-2006；……系統總體架構〔給出系統總體結構圖并進行簡要說明。〕示例：圖3-1XX如圖3-1所示中間業務處理層通過API接口與業務對象BO與數據代理DP連接實現對數據庫的查詢操作和外部系統和通用服務的連接。講查詢結果按功能模塊處理后，通過API接口交給應用界面顯示給用戶。……系統功能結構〔詳細描述總體設計中系統功能的各個模塊以及子模塊的結構，并附系統功能結構圖。〕示例：根據本項目的建設需求，對學生職業生涯培養系統、平板互動教學平臺、課題互動平臺、課件制作平臺以及試卷題庫管理生成系統的建設系統，每個系統下面具有子功能我的生涯規劃、認識專業、生涯規劃管理員操作、課程建立、微課堂、學生統計、學生管理、課程管理、白板互動、課堂作業、互動活動、教材與編目管理、教學進度管理、主備文檔模板管理評課、在線組卷、私人題庫、發布測驗、答題情況等具體結構如圖3-2圖3-2XX設計策略與方法〔描述系統設計為滿足系統架構所需使用的策略和方法。〕示例：擴展策略：首先采用了B/S開發架構，便于將來維護，同時也便于與其他相關系統互通。具體業務中增加了底層的數據維護功能，便于業務自身的擴展。折衷策略：本系統在習慣性和統一規范管理之間采取一定的折衷處理，考慮到學校老師習慣等原因，在操作界面上和操作流程上重點考慮接近現實流程。本系統在性能和安全上進行折衷處理，保證性能的前提下，重點以系統安全為主。設計方法：經過系統分析，設計中采用原形法，針對相同類似功能采用原形與設計重用，具體設計過程中采用面向對象設計。……系統功能大綱〔以列表的形式描述系統功能的編號、名稱和功能概要。〕示例：表3-1模塊編號模塊/功能名稱功能概要MC學生職業生涯培養系統主模塊MC01我的生涯規劃在“我的生涯規劃”“自我分析”頁面，學生可根據自己的性格、興趣、價值觀和能力等等方面，進行自我分析；在“長期目標”頁面，學生可對自己的職業目標和專業目標進行規劃，填寫目標內容后；在“我的榜樣人物”頁面，學生可添加多個自己的榜樣人物，并且可以隨時對榜樣人物進行添加、修改、刪除等操作；在“短期目標”頁面，學生可根據高一/高二/高三目標進行歸納，包括目標內容、學業發展計劃、綜合素質提高計劃、身心發展計劃和其他成長足跡等；在“生涯規劃書”頁面，學生可對自己的生涯規劃書進行編輯和導出MC02認識專業在“認識專業”頁面，可對相關專業進行分類搜索，點擊“專業名稱”可查看該專業詳細內容；點擊“開設院校”可查看該專業開設院校。。MC03生涯規劃管理操作管理員進入生涯規劃，可對全校學生所創建的生涯規劃進行搜索、查看、導出等操作，其他操作均與學生一致。………………系統部署結構〔描述系統服務器的總體部署情況。〕示例：圖3-3XXXXX系統采用的是集中式的模式，集中部屬在中心集群上面。數據庫分兩類，運算數據庫和生產數據庫，數據庫集群上共有4個生產集群與4個運算集群。……子系統/模塊設計子系統/子模塊1〔根據本項目的需求列出本系統的各模塊功能設計，包含功能概要、業務規模、界面設計、關鍵SQL語句等。〕示例：4.1.1功能概要功能概要說明：我的生涯規劃，是學生可根據自己的性格、興趣、價值觀和能力等等方面，進行自我分析；在“長期目標”頁面，學生可對自己的職業目標和專業目標進行規劃。4.1.2業務規模學校學生可以每半學期記錄制定一次自己的生涯規劃。4.1.3界面設計圖4-1界面構造：標簽、BUTTON按鈕、列表控件、翻頁控件進入操作：學生職業生涯培養系統——我的生涯規劃——自我分析、長期目標、我的榜樣人物、短期目標體和生涯規劃書登陸后初始狀態：默認為我的生涯規劃界面頁面切換后狀態：顯示上次輸入值退出操作：切換模塊、退出系統、關閉瀏覽器4.1.4關鍵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子系統/子模塊2……子系統/子模塊XXX……數據庫設計數據庫的命名規則〔闡述此數據庫設計說明書的數據庫命名規則。〕示例：5.1數據庫（database）命名規則數據庫名長度：不超過INFORMIX規定長度(十八位)；采用英文形式，規則如XXX；數據庫名由兩部分組成：系統名+DB；系統名由英文單詞構成，每個單詞首字母大寫，單詞可采取縮寫形式；附表提供的詞根表作為構詞的唯一依據。……數據庫概念模型〔用ER圖表示數據庫的概念模型。〕示例：圖5-1用戶通過登錄本系統進行線上咨詢，查詢、信息修改、意見反饋等操作，后臺收到修改信息，對用戶信息進行核實，根據修改信息的結果，進行再次確認，并把結果錄入檔案中。登錄本系統易于檔案進行工作量統計檔案管理和各種工作登記等。表設計示例：1）tc"表格BACKS_REASON_ALL的列清單"\l4表BACKS_REASON_ALL的列清單表5-1代碼數據類型注釋DD_IDVARCHAR2(20)DD_CODEVARCHAR2(20)DD_DESCVARCHAR2(100)DD_STATUSVARCHAR2(2)2）tc"表格BACKS_REASON_DOC的列清單"\l4表BACKS_REASON_DOC的列清單表5-2XX代碼數據類型注釋DD_IDVARCHAR2(20)DD_CODEVARCHAR2(20)DD_DESCVARCHAR2(100)DD_STATUSVARCHAR2(2)3)tc"表格BACKS_REASON_DOC的列清單"\l4表XXX的列清單存儲過程/包設計〔闡述數據庫存儲過程的設計，列出各個存儲過程對應的數據庫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;接口設計外部接口設計〔描述本系統的外部硬件接口設計，包括接口形式、輸入輸出參數、傳輸頻率等。〕示例：表6-1編號系統接口形式輸入參數出口參數調用頻率1學生職業生涯培養Key系統USB端口InputOutput500次/天內部接口設計〔描述本系統的內部硬件接口設計，包括接口形式、輸入輸出參數以及調用頻率狀況等。〕示例：表6-2XX編號系統接口形式輸入參數出口參數調用頻率1登陸方式接口HCI用戶名、密碼用戶ID、角色、機構500次/天系統非功能設計〔詳細描述系統的非功能性設計，包含并不限于以下內容。〕性能設計〔從整體描述軟件在性能上需要達到的要求。〕示例：1、易用性統一的界面風格：方便用戶習慣操作。優化頁面數據下載方式，適應不同帶寬的網絡訪問。（撥號、寬帶、GPRS訪問）清晰友好的在線幫助：使操作人員在短時間內掌握系統的使用，并可以隨時獲取在線的指導。離線應用：由于