xx系統(tǒng)概要設(shè)計(jì)說(shuō)明書

XX學(xué)院XX系統(tǒng)概要設(shè)計(jì)說(shuō)明書xxxxxxXXXXXXXX年XX月XX日目錄第一章引言41.1編寫目的41.2工程背景41.3定義4專門術(shù)語(yǔ)4縮寫41.4參考資料4第二章總體設(shè)計(jì)52.1需求規(guī)定5對(duì)功能的規(guī)定5對(duì)性能的規(guī)定5輸入/輸出要求5數(shù)據(jù)管理能力要求6故障處理要求62.2其它專門要求62.3運(yùn)行環(huán)境72.6根本設(shè)計(jì)概念和處理流程72.6.2軟件總體模型7技術(shù)架構(gòu)7部署模型7第三章系統(tǒng)結(jié)構(gòu)設(shè)計(jì)83.1功能需求與程序模塊的關(guān)系83.3XX功能83.4．…8結(jié)構(gòu)8對(duì)象關(guān)系與類結(jié)構(gòu)9人工處理過(guò)程9第四章接口設(shè)計(jì)104.1外部接口10用戶界面10軟件接口10硬件接口104.2內(nèi)部接口10第五章運(yùn)行設(shè)計(jì)115.1運(yùn)行模塊的組合115.2運(yùn)行控制115.3運(yùn)行時(shí)間11第六章出錯(cuò)處理設(shè)計(jì)136.1出錯(cuò)輸出信息136.2出錯(cuò)處理對(duì)策13第七章平安保密設(shè)計(jì)14第八章維護(hù)設(shè)計(jì)15引言編寫目的編寫本概要設(shè)計(jì)的目的是：XXXX。本文的預(yù)期讀者為：XXXX系統(tǒng)的設(shè)計(jì)、開發(fā)人員；XXXX系統(tǒng)的驗(yàn)收、評(píng)審人員。工程背景定義專門術(shù)語(yǔ)縮寫系統(tǒng)：假設(shè)未特別指出，統(tǒng)指XXXX系統(tǒng)。SQL：StructuredQueryLanguage〔結(jié)構(gòu)化查詢語(yǔ)言〕。參考資料總體設(shè)計(jì)需求規(guī)定對(duì)功能的規(guī)定XXXX系統(tǒng)主要完成XXXX的相關(guān)工作，它包括：。具體包括：XXXX功能；要求系統(tǒng)能有效、快速、平安、可靠和無(wú)誤的完成上述操作。并要求客戶端的界面要簡(jiǎn)單明了、易于操作，效勞器程序利于維護(hù)。對(duì)性能的規(guī)定時(shí)間特性的要求：在正常網(wǎng)速的條件下，網(wǎng)頁(yè)刷新時(shí)間不長(zhǎng)于XX秒。輸入/輸出要求輸入的數(shù)據(jù)為管理類數(shù)據(jù)，輸入的數(shù)據(jù)較簡(jiǎn)單，沒(méi)有特殊要求。在數(shù)據(jù)輸入的相關(guān)Web頁(yè)面，須提供頁(yè)面數(shù)據(jù)合法性校驗(yàn)，包括：對(duì)數(shù)據(jù)類型的檢查、對(duì)日期類型數(shù)據(jù)的檢查、對(duì)特定字符長(zhǎng)度的檢查。使用Web頁(yè)面輸出數(shù)據(jù)，包括頁(yè)面顯示的數(shù)據(jù)、可供下載的文檔。對(duì)這類數(shù)據(jù)沒(méi)有特殊要求。數(shù)據(jù)管理能力要求故障處理要求軟件支撐環(huán)境運(yùn)行錯(cuò)誤：數(shù)據(jù)庫(kù)運(yùn)行錯(cuò)誤：系統(tǒng)無(wú)法使用，將提供錯(cuò)誤提示頁(yè)面，并記錄日志。系統(tǒng)配置參數(shù)錯(cuò)誤：系統(tǒng)提供錯(cuò)誤提示頁(yè)面，要求管理員修改相關(guān)配置參數(shù)。配置參數(shù)的修改方法應(yīng)參考相關(guān)為管理員提供的手冊(cè)。系統(tǒng)參數(shù)初始化錯(cuò)誤：提供系統(tǒng)初始化功能，用于成批完成系統(tǒng)初始化。在初始化過(guò)程中，對(duì)于嚴(yán)重影響平臺(tái)運(yùn)行的錯(cuò)誤，提供錯(cuò)誤提示頁(yè)面。對(duì)于普通錯(cuò)誤，記錄日志。應(yīng)用程序錯(cuò)誤：由應(yīng)用程序提供錯(cuò)誤提示頁(yè)面，相關(guān)錯(cuò)誤應(yīng)記錄日志。其它專門要求先進(jìn)性：采用先進(jìn)成熟的技術(shù)，確保系統(tǒng)的先進(jìn)性、經(jīng)濟(jì)性和實(shí)用性。平安可靠：提供的應(yīng)用框架及平臺(tái)本身提供給用平安保證，并可以和第三方平安手段，如認(rèn)證、加密、電子簽名等進(jìn)行集成。必須保證數(shù)據(jù)的平安性和保密性。對(duì)于基于平臺(tái)開發(fā)的應(yīng)用系統(tǒng)，只允許有權(quán)限的人員進(jìn)行操作和瀏覽信息。必須有平安的手段來(lái)進(jìn)行權(quán)限控制。開放互連：系統(tǒng)應(yīng)對(duì)各類業(yè)務(wù)系統(tǒng)、數(shù)據(jù)庫(kù)系統(tǒng)、WEB信息等具有通用的或可定制的接口策略和連接方法。標(biāo)準(zhǔn)性：開發(fā)過(guò)程控制、開發(fā)技術(shù)、系統(tǒng)編碼、文檔應(yīng)標(biāo)準(zhǔn)化，并遵循相應(yīng)的國(guó)內(nèi)外標(biāo)準(zhǔn)。開發(fā)結(jié)束，需要提供必要的文檔資料?？煽啃裕罕ＷC系統(tǒng)的可靠運(yùn)行和在升級(jí)過(guò)程中的方便快捷。可擴(kuò)充性：系統(tǒng)應(yīng)當(dāng)可以根據(jù)需求的變化，方便地進(jìn)行功能的調(diào)整、增減，模塊的升級(jí)和系統(tǒng)架構(gòu)的逐步完善。界面友好、操作方便：操作界面要直觀、簡(jiǎn)單、貼近實(shí)際，操作過(guò)程應(yīng)當(dāng)盡量簡(jiǎn)化，符合實(shí)際過(guò)程。身份認(rèn)證過(guò)程即要保證平安，也要盡量簡(jiǎn)化認(rèn)證過(guò)程?？删S護(hù)性：系統(tǒng)維護(hù)應(yīng)當(dāng)簡(jiǎn)單。運(yùn)行環(huán)境系統(tǒng)將由兩局部程序組成，安裝在各業(yè)務(wù)人員客戶機(jī)上的客戶程序〔WEB瀏覽器〕及應(yīng)用效勞器和數(shù)據(jù)效勞器程序。2.6根本設(shè)計(jì)概念和處理流程2.6.2軟件總體模型有哪些模塊，模塊之間的關(guān)系，以及與外界的交互。2.6.3技術(shù)架構(gòu)2.6.4部署模型系統(tǒng)結(jié)構(gòu)設(shè)計(jì)功能需求與程序模塊的關(guān)系需求模塊3.3XX功能3.4．…3.4.1結(jié)構(gòu)現(xiàn)對(duì)模塊進(jìn)行功能說(shuō)明：3.4.2對(duì)象關(guān)系與類結(jié)構(gòu)3.4.3人工處理過(guò)程接口設(shè)計(jì)外部接口用戶界面在用戶界面局部，根據(jù)需求分析的結(jié)果，用戶需要一個(gè)用戶友善界面。在界面設(shè)計(jì)上，應(yīng)做到簡(jiǎn)單明了，易于操作，并且要注意到界面的布局，應(yīng)突出的顯示重要以及出錯(cuò)信息?？偟膩?lái)說(shuō)，系統(tǒng)的用戶界面應(yīng)作到可靠性、簡(jiǎn)單性、易學(xué)習(xí)和使用軟件接口硬件接口內(nèi)部接口內(nèi)部接口方面，各模塊之間采用函數(shù)調(diào)用、參數(shù)傳遞、返回值的方式進(jìn)行信息傳遞。具體參數(shù)的結(jié)構(gòu)將在下面數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)的內(nèi)容中說(shuō)明。接口傳遞的信息將是以數(shù)據(jù)結(jié)構(gòu)封裝了的數(shù)據(jù)，以參數(shù)傳遞或返回值的形式在各模塊間傳輸。運(yùn)行設(shè)計(jì)運(yùn)行模塊的組合客戶機(jī)程序在有輸入時(shí)啟動(dòng)接收數(shù)據(jù)模塊，通過(guò)各模塊之間的調(diào)用，讀入并對(duì)輸入進(jìn)行格式化。在接收數(shù)據(jù)模塊得到充分的數(shù)據(jù)時(shí)，將調(diào)用網(wǎng)絡(luò)傳輸模塊，將數(shù)據(jù)通過(guò)網(wǎng)絡(luò)送到效勞器，并等待接收效勞器返回的信息。接收到返回信息后隨即調(diào)用數(shù)據(jù)輸出模塊，對(duì)信息進(jìn)行處理，產(chǎn)生相應(yīng)的輸出。效勞器程序的接收網(wǎng)絡(luò)數(shù)據(jù)模塊必須始終處于活動(dòng)狀態(tài)。接收到數(shù)據(jù)，調(diào)用數(shù)據(jù)處理/查詢模塊對(duì)數(shù)據(jù)庫(kù)進(jìn)行訪問(wèn)，完成后調(diào)用網(wǎng)絡(luò)發(fā)送模塊，將信息返回客戶機(jī)。運(yùn)行控制運(yùn)行控制將嚴(yán)格按照各模塊間函數(shù)調(diào)用關(guān)系來(lái)實(shí)現(xiàn)。在各事務(wù)中心模塊中，需對(duì)運(yùn)行控制進(jìn)行正確的判斷，選擇正確的運(yùn)行控制路徑。在網(wǎng)絡(luò)傳方面，客戶機(jī)在發(fā)送數(shù)據(jù)后，將等待效勞器確實(shí)認(rèn)收到信號(hào)，收到后，再次等待效勞器發(fā)送答復(fù)數(shù)據(jù)，然后對(duì)數(shù)據(jù)進(jìn)行確認(rèn)。效勞器在接到數(shù)據(jù)后發(fā)送確認(rèn)信號(hào)，在對(duì)數(shù)據(jù)處理、訪問(wèn)數(shù)據(jù)庫(kù)后，將返回信息送回客戶機(jī)，并等待確認(rèn)。運(yùn)行時(shí)間在軟體的需求分析中，對(duì)運(yùn)行時(shí)間的要求為必須對(duì)作出的操作有較快的反響。網(wǎng)絡(luò)硬件對(duì)運(yùn)行時(shí)間有最大的影響，當(dāng)網(wǎng)絡(luò)負(fù)載量大時(shí)，對(duì)操作反響將受到很大的影響。其次是效勞器的性能，這將影響對(duì)數(shù)據(jù)庫(kù)訪問(wèn)時(shí)間即操作時(shí)間的長(zhǎng)短，影響加大客戶機(jī)操作的等待時(shí)間，所以必須使用高性能的效勞器。硬件對(duì)本系統(tǒng)的速度影響將會(huì)大于軟件的影響。出錯(cuò)處理設(shè)計(jì)出錯(cuò)輸出信息程序在運(yùn)行時(shí)主要會(huì)出現(xiàn)兩種錯(cuò)誤：1、由于輸入信息，或無(wú)法滿足要求時(shí)產(chǎn)生的錯(cuò)誤，稱為軟錯(cuò)誤。2、由于其它問(wèn)題，如網(wǎng)絡(luò)傳輸超時(shí)等，產(chǎn)生的問(wèn)題，稱為硬錯(cuò)誤。對(duì)于軟錯(cuò)誤，須在操作成功判斷及輸入數(shù)據(jù)驗(yàn)證模塊由數(shù)據(jù)進(jìn)行數(shù)據(jù)分析，判斷錯(cuò)誤類型，再生成相應(yīng)的錯(cuò)誤提示語(yǔ)句，送到輸出模塊中。對(duì)與硬錯(cuò)誤，可在出錯(cuò)的相應(yīng)模塊中輸出簡(jiǎn)單的出錯(cuò)語(yǔ)句，并將程序重置。返回輸入階段。出錯(cuò)信息必須給出相應(yīng)的出錯(cuò)原因，例：“該編碼已使用〞、“無(wú)該條記錄〞等。出錯(cuò)處理對(duì)策效勞器安裝不間斷電源以防止停電或電壓不穩(wěn)造成的數(shù)據(jù)喪失的損失。假設(shè)真斷電時(shí)，客戶機(jī)上將不會(huì)有太大的影響，主要是效勞器上：在斷電后恢復(fù)過(guò)程可采用XXX數(shù)據(jù)庫(kù)的日志文件，對(duì)其進(jìn)行ROLLBAC