XXX系統(tǒng)VerX.X概要設(shè)計(jì)說明書共22頁第22頁密級：秘密系統(tǒng)名稱：XXXX系統(tǒng)系統(tǒng)版本：X.X文檔分類：系統(tǒng)設(shè)計(jì)文件編號：XXXX系統(tǒng)VerX.X概要設(shè)計(jì)說明書XXX計(jì)算機(jī)有限公司XXXX年X月

目錄TOC\o"1-3"\h\z目錄 21. 引言 31.1 文檔目的 31.2 項(xiàng)目概述 31.3 參考資料 31.4 術(shù)語定義 31.5 修改記錄 32. 系統(tǒng)概述 32.1 系統(tǒng)實(shí)現(xiàn)目標(biāo) 32.2 條件與限制 32.3 運(yùn)行環(huán)境 33. 需求概述 33.1. 總體描述 33.2. 系統(tǒng)角色 33.3. 系統(tǒng)功能 33.3.4. 功能劃分 33.3.5. 用例清單 33.4. 性能和運(yùn)行需求 34. 總體設(shè)計(jì) 34.1 設(shè)計(jì)原則 34.2 設(shè)計(jì)規(guī)范 34.3 軟件體系結(jié)構(gòu) 35. 模塊結(jié)構(gòu)設(shè)計(jì) 35.1 組件模塊總體設(shè)計(jì) 35.1.1. 組件模塊的劃分和功能描述 35.1.2. 組件模塊關(guān)系 35.1.3. 組件模塊的物理分布 35.1.4. 組件模塊與用例映射 35.2 組件模塊描述 35.2.1. 組件模塊1 36. 用例實(shí)現(xiàn) 37. 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) 38. 接口設(shè)計(jì) 39. 系統(tǒng)安全設(shè)計(jì) 39.1 系統(tǒng)故障預(yù)防和恢復(fù) 39.2 用戶管理和權(quán)限控制 39.3 數(shù)據(jù)備份與恢復(fù) 39.3.1. 數(shù)據(jù)備份 39.3.2. 數(shù)據(jù)恢復(fù) 310. 系統(tǒng)運(yùn)行設(shè)計(jì) 310.1 運(yùn)行模塊組合 310.2 運(yùn)行控制 311. 系統(tǒng)出錯(cuò)處理設(shè)計(jì) 311.1 出錯(cuò)處理信息 311.1.1. 通訊線路錯(cuò)誤 311.1.2. 系統(tǒng)環(huán)境錯(cuò)誤 311.1.3. 應(yīng)用設(shè)計(jì)錯(cuò)誤 311.2 出錯(cuò)處理對策 312. 系統(tǒng)維護(hù)設(shè)計(jì) 312.1 數(shù)據(jù)維護(hù) 312.2 功能維護(hù) 313. 系統(tǒng)版本設(shè)計(jì) 314. 附件 3引言文檔目的簡要說明編寫這份概要設(shè)計(jì)說明書的目的，指出預(yù)期的讀者。本概要設(shè)計(jì)說明書的編寫目的是為了說明系統(tǒng)總體設(shè)計(jì)的技術(shù)方案，從程序系統(tǒng)的設(shè)計(jì)考慮，包括系統(tǒng)的基本處理流程、模塊劃分、功能分配、接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等內(nèi)容，以向整個(gè)設(shè)計(jì)期提供關(guān)于程序系統(tǒng)的邏輯和數(shù)據(jù)功能實(shí)現(xiàn)方式的總體描述，從而作為程序詳細(xì)設(shè)計(jì)或編碼的基礎(chǔ)。設(shè)計(jì)階段將以本文檔為核心文檔。本概要設(shè)計(jì)說明書的適用讀者為：軟件開發(fā)者、測試人員。項(xiàng)目概述1.說明待開發(fā)的軟件系統(tǒng)的名稱2.列出本項(xiàng)目的任務(wù)委托單位、開發(fā)單位、協(xié)作單位、用戶單位3.說明項(xiàng)目背景，敘述該項(xiàng)軟件開發(fā)的意圖、應(yīng)用目標(biāo)、作用范圍以及其他應(yīng)向讀者說明的有關(guān)該軟件開發(fā)的背景材料。如果本次開發(fā)的軟件系統(tǒng)是一個(gè)更大的系統(tǒng)的一個(gè)組成部分，則要說明該更大系統(tǒng)的組成和介紹本系統(tǒng)與其它相關(guān)系統(tǒng)的關(guān)系和接口部分4.保密說明：本項(xiàng)為可選項(xiàng)，一般的軟件公司都會要求對軟件開發(fā)的概要設(shè)計(jì)文檔進(jìn)行保密，不允許被復(fù)制、使用和擴(kuò)散到公司之外的范圍，如果需要強(qiáng)調(diào)則允許做相關(guān)的保密說明5.版權(quán)說明：本項(xiàng)為可選項(xiàng)，若有必要，才要作有關(guān)的描述。參考資料列出編寫本報(bào)告時(shí)參考的文件(如經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級機(jī)關(guān)的批文等)、資料、技術(shù)標(biāo)準(zhǔn)，以及他們的作者、標(biāo)題、編號、發(fā)布日期和出版單位。這些文件主要包括：本軟件開發(fā)所經(jīng)核準(zhǔn)的合同或標(biāo)書或可行性報(bào)告等文檔軟件開發(fā)計(jì)劃書需求分析報(bào)告測試方案（若存在初稿的話）與本項(xiàng)目有關(guān)的已發(fā)表的文件或資料本文件中各處引用的文件、資料，所采用的軟件開發(fā)標(biāo)準(zhǔn)和規(guī)范編號資料名稱簡介作者日期出版單位列出編寫本報(bào)告時(shí)查閱的Intenet上雜志、專業(yè)著作、技術(shù)標(biāo)準(zhǔn)以及他們的網(wǎng)址。網(wǎng)站簡介術(shù)語定義列出本文檔中所引用到的專門術(shù)語的定義和首字母縮寫詞、縮略語的原文，以便對概要設(shè)計(jì)說明書進(jìn)行適當(dāng)?shù)慕忉屝薷挠涗浘幪栃薷膬?nèi)容描述修改人審核人批準(zhǔn)人修改日期備注

系統(tǒng)概述概要地介紹本軟件系統(tǒng)，只要求提供影響設(shè)計(jì)的一般因素，不必太詳細(xì)地描述大量細(xì)節(jié)，本章主要目的僅僅是使本設(shè)計(jì)說明書更加易于理解，建議根據(jù)系統(tǒng)設(shè)計(jì)的實(shí)際需要可以有選擇地從以下方面進(jìn)行概要描述：系統(tǒng)實(shí)現(xiàn)目標(biāo)、條件與限制、運(yùn)行環(huán)境、需求概述系統(tǒng)實(shí)現(xiàn)目標(biāo)說明完成本項(xiàng)目要達(dá)到的目標(biāo)，可從以下幾方面考慮設(shè)計(jì)：人力與設(shè)備費(fèi)用的節(jié)?。惶幚硭俣鹊奶岣?；控制精度或生產(chǎn)能力的提高；管理信息服務(wù)的改進(jìn)；決策系統(tǒng)的改進(jìn)；人員工作效率的提高；安全可靠性的保證；條件與限制為可選項(xiàng)，只要當(dāng)軟件系統(tǒng)的設(shè)計(jì)或開發(fā)受到某種特定的限制，或者可直接能影響系統(tǒng)設(shè)計(jì)的某種因素，這些因素可能成為系統(tǒng)的設(shè)計(jì)約束，他們的改變可能會影響某些需求的實(shí)現(xiàn)時(shí)，才需要做概要介紹。若存在以下方面的系統(tǒng)約束或條件限制時(shí)，可以進(jìn)行相關(guān)的闡明：（但不限于這些）1.為完成本軟件系統(tǒng)應(yīng)具備的特定條件、開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件,如：現(xiàn)階段還未到位的設(shè)備、資源等需要做出相應(yīng)的約束說明2.必要時(shí)，還應(yīng)說明用戶及分合同承包者承擔(dān)的工作、完成期限及其他條件與限制，如果用戶及分合同承包者對系統(tǒng)的實(shí)現(xiàn)起到的某些作用會直接影響系統(tǒng)設(shè)計(jì)的成敗則要特別說明3. 本系統(tǒng)的設(shè)計(jì)規(guī)范需要受到某些特定的行業(yè)規(guī)范的限制4. 本系統(tǒng)的開發(fā)需要受到用戶對系統(tǒng)的工程化管理的某些特別的要求，包括用戶規(guī)定對系統(tǒng)實(shí)現(xiàn)的全過程的變更規(guī)定5. 本系統(tǒng)設(shè)計(jì)工作所需的一些假定條件和必須滿足的約束，如本功能的開發(fā)假定用戶會熟練使用SQL語言，本功能的實(shí)現(xiàn)應(yīng)該在某功能實(shí)現(xiàn)前開發(fā)完成等6. 本系統(tǒng)的設(shè)計(jì)可能需要使用的所有購入構(gòu)件、所有適用的許可或使用限制，以及所有相關(guān)的兼容性及互操作性或接口標(biāo)準(zhǔn)的有關(guān)限制和規(guī)定運(yùn)行環(huán)境概要地說明本軟件系統(tǒng)的運(yùn)行環(huán)境的拓樸結(jié)構(gòu)和布局，分別說明前、后臺及網(wǎng)關(guān)或中間件的運(yùn)行環(huán)境,應(yīng)包括通訊條件、網(wǎng)絡(luò)環(huán)境、硬件配置、軟件系統(tǒng)等其中硬件環(huán)境：要求列出為運(yùn)行本軟件所要求的硬件最小配置：處理器的型號、內(nèi)存容量所要求的硬盤空間、分區(qū)格式、相關(guān)的記錄格式、設(shè)備的型號和數(shù)量、聯(lián)機(jī)/脫機(jī)等I/O設(shè)備（聯(lián)機(jī)/脫機(jī)）網(wǎng)絡(luò)相關(guān)設(shè)備（型號、數(shù)量）支持軟件：說明為運(yùn)行本軟件所需要的支持軟件，如：操作系統(tǒng)名稱、對應(yīng)的版本號、相關(guān)的ServicePackage編譯器和對應(yīng)的版本號數(shù)據(jù)庫管理系統(tǒng)和對應(yīng)版本號其他支持軟件這里只要求概要的說明一下，以便幫助理解本概要設(shè)計(jì)說明書，可參考以下格式：【前臺】計(jì)算機(jī)：IBMPC兼容機(jī)。操作系統(tǒng)：MicrosoftWindows95/97/98/2000/NT操作系統(tǒng)數(shù)據(jù)庫系統(tǒng)：IBMDB2數(shù)據(jù)庫系統(tǒng)（客戶端）應(yīng)用軟件：XXXXXXXX（客戶端）網(wǎng)絡(luò)：Ethernet,TCP/IP【后臺】計(jì)算機(jī)：IBMRS/6000操作系統(tǒng)：IBMAIX操作系統(tǒng)數(shù)據(jù)庫系統(tǒng)：IBMDB2數(shù)據(jù)庫系統(tǒng)（服務(wù)端）應(yīng)用軟件：XXXXXXXX（服務(wù)端）網(wǎng)絡(luò)：Ethernet,TCP/IP需求概述根據(jù)系統(tǒng)設(shè)計(jì)的實(shí)際需要，簡要介紹系統(tǒng)的需求情況，不必詳細(xì)描述需求的具體細(xì)節(jié)，只僅僅要求能夠更好幫助理解本設(shè)計(jì)說明書的內(nèi)容，建議有選擇地從功能需求、性能需求和運(yùn)行需求進(jìn)行分別描述，對于直接影響系統(tǒng)設(shè)計(jì)的關(guān)鍵或主要功能、性能以及運(yùn)行要求等方面進(jìn)行概要介紹，如果性能和運(yùn)行需求方面對設(shè)計(jì)影響不大，則允許不必說明總體描述對系統(tǒng)的整體需求進(jìn)行概述系統(tǒng)角色描述系統(tǒng)的用戶，權(quán)限等Actor縮寫名稱描述[英語簡稱]系統(tǒng)功能功能劃分對系統(tǒng)進(jìn)行功能劃分用例清單根據(jù)劃分，列出各個(gè)功能模塊功能ID功能名稱系統(tǒng)角色使用權(quán)限描述列出所有系統(tǒng)角色，并用√表示具有相應(yīng)權(quán)限性能和運(yùn)行需求總體設(shè)計(jì)設(shè)計(jì)原則介紹本系統(tǒng)的結(jié)構(gòu)設(shè)計(jì)原則和總體設(shè)計(jì)指導(dǎo)思想，主要從系統(tǒng)設(shè)計(jì)實(shí)現(xiàn)的目標(biāo)來考慮，比如：處理速度、安全保密性、可擴(kuò)展性等方面進(jìn)行闡述，可以使用一些套話稍做修改即可。建議參考以下范例進(jìn)行描述：數(shù)據(jù)實(shí)時(shí)性強(qiáng)監(jiān)控的實(shí)時(shí)性是不言而喻的。無論實(shí)時(shí)檢測還是動態(tài)顯示交易匯總數(shù)據(jù)和盤中異常結(jié)果，都要求實(shí)時(shí)監(jiān)控的算法盡量優(yōu)化，處理簡潔，這樣才能真正達(dá)到實(shí)時(shí)監(jiān)控的目的，為總部進(jìn)行盤中稽核和及時(shí)處理異常情況提供有效的手段?？蓴U(kuò)充性強(qiáng)由于交易業(yè)務(wù)是不斷擴(kuò)展的，監(jiān)控的指標(biāo)及功能都是不斷擴(kuò)大或變化的，故系統(tǒng)必須具有良好的可擴(kuò)充性。系統(tǒng)設(shè)計(jì)應(yīng)盡可能結(jié)構(gòu)化、模塊化，并與其他子系統(tǒng)預(yù)留相應(yīng)的接口?？删S護(hù)性好由于證券市場、政策及其管理是隨著整個(gè)國民經(jīng)濟(jì)的發(fā)展而變化的，要求對交易業(yè)務(wù)的實(shí)時(shí)監(jiān)控具有相當(dāng)?shù)撵`活性，以便于維護(hù)。先進(jìn)性系統(tǒng)采用國際流行的J2EE開放式框架，主要軟硬件設(shè)備符合國際標(biāo)準(zhǔn)，集成了國際水平的主流生產(chǎn)廠的先進(jìn)產(chǎn)品，應(yīng)用軟件采用B/S結(jié)構(gòu)。數(shù)據(jù)完整性、安全性高財(cái)務(wù)系統(tǒng)數(shù)據(jù)的完整性和安全性是非常重要的。一個(gè)安全的客戶/服務(wù)器系統(tǒng)應(yīng)該是客戶端機(jī)器的任何操作都通過服務(wù)器來實(shí)現(xiàn)其一致性和完整性控制。數(shù)據(jù)庫及財(cái)務(wù)稽核系統(tǒng)本身都應(yīng)提供分級授權(quán)、日志記錄等手段來確保系統(tǒng)的安全。設(shè)計(jì)規(guī)范說明可以引用公司現(xiàn)有的各種設(shè)計(jì)規(guī)范或各種軟件開發(fā)的國家標(biāo)準(zhǔn)或規(guī)范，主要包括：（不限于以下幾種，也不指定）命名約定規(guī)定系統(tǒng)和子系統(tǒng)名,程序名,數(shù)據(jù)庫表(文件)名,數(shù)據(jù)名,變量名等的編制規(guī)范。界面約定規(guī)定屏幕界面的總體布局，如菜單行、顯示主體、圖標(biāo)按鈕、提示信息、出錯(cuò)信息等規(guī)范化，統(tǒng)一風(fēng)格。程序編寫規(guī)范根據(jù)采用的編程工具特點(diǎn)，制定規(guī)范化要求，使程序易讀易懂，可維護(hù)，可移植。具體選用的規(guī)范，只要對設(shè)計(jì)有所幫助就可以羅列，編號及相關(guān)規(guī)范標(biāo)題可以自行決定。對于引用公司事先制訂的有關(guān)規(guī)范或現(xiàn)存的各種國家標(biāo)準(zhǔn)等規(guī)范，則可以簡單地描述，并參見《XXXXXXXX》規(guī)范或標(biāo)準(zhǔn)，文件可以作為本概要設(shè)計(jì)說明書的附件進(jìn)行保存如果一個(gè)系統(tǒng)比較大需要拆分成若干個(gè)子系統(tǒng)，而每個(gè)子系統(tǒng)需要各自編制概要設(shè)計(jì)文檔，則只需要在一個(gè)總的概要設(shè)計(jì)說明書進(jìn)行描述，其他子系統(tǒng)允許不專門進(jìn)行描述，或注明參見《XXXXXXX》概要設(shè)計(jì)說明書。軟件體系結(jié)構(gòu)簡要介紹系統(tǒng)的總體結(jié)構(gòu)和概要功能，可以通過畫系統(tǒng)設(shè)計(jì)總體框架結(jié)構(gòu)圖的方式，再附上簡單的文字說明,對本軟件系統(tǒng)的總體功能進(jìn)行概要描述。對于采用J2EE平臺的系統(tǒng)，參考如下：系統(tǒng)的體系架構(gòu)是一個(gè)系統(tǒng)的骨架，其重要性對一個(gè)系統(tǒng)的建設(shè)能否成功至關(guān)重要。建立一個(gè)合適的體系架構(gòu)關(guān)系到系統(tǒng)的業(yè)務(wù)需求；關(guān)系到系統(tǒng)的運(yùn)行模式；關(guān)系到系統(tǒng)的性能需求，如安全性、可擴(kuò)展性等。在本系統(tǒng)中，我們將遵循J2EE規(guī)范進(jìn)行設(shè)計(jì)和開發(fā)。J2EE體系結(jié)構(gòu)由SUN公司提出，它定義了如何開發(fā)、配置及實(shí)現(xiàn)一個(gè)企業(yè)應(yīng)用，提供了對EJB、Servlets、JSP、JDBC、CORBA以及XML技術(shù)的全面支持。J2EE提供了一個(gè)企業(yè)級的計(jì)算模型和運(yùn)行環(huán)境，用于開發(fā)和部署多層體系結(jié)構(gòu)的應(yīng)用。它通過提供企業(yè)計(jì)算環(huán)境所必須的各種服務(wù)，使得部署在J2EE平臺上的多層應(yīng)用可以實(shí)現(xiàn)高可用性、安全性、可擴(kuò)展性和可靠性。上圖中是一個(gè)典型的分布式多層應(yīng)用的模型，它將整個(gè)應(yīng)用按照功能劃分為表示層、商業(yè)邏輯層和數(shù)據(jù)層三個(gè)部分。各個(gè)層次在邏輯上相互獨(dú)立。表示層是應(yīng)用的用戶接口部分，它擔(dān)負(fù)著用戶與應(yīng)用間的對話功能。它可用于檢查用戶從鍵盤等輸入的數(shù)據(jù)，顯示系統(tǒng)處理后輸出的數(shù)據(jù)。在變更用戶接口時(shí)，只需要改寫顯示控制和數(shù)據(jù)檢查程序，而并不會因此影響其他層的功能。而數(shù)據(jù)檢查的功能也只是限于數(shù)據(jù)的形式和實(shí)際取值范圍，不包括有關(guān)業(yè)務(wù)本身的處理邏輯。另外圖形界面的結(jié)構(gòu)也是不固定的，這便于以后可靈活變更。例如：可以在一個(gè)窗口中不是放入幾個(gè)功能，而是按照功能分割窗口，以便每個(gè)窗口的功能簡潔。在原有C/S結(jié)構(gòu)中客戶端的業(yè)務(wù)邏輯現(xiàn)在統(tǒng)一并入到新增出的商業(yè)邏輯層中。商業(yè)邏輯層實(shí)際是整個(gè)應(yīng)用的本體，它負(fù)責(zé)整個(gè)系統(tǒng)的業(yè)務(wù)處理邏輯。表示層和商業(yè)邏輯層間的數(shù)據(jù)交換盡量簡潔，避免“一次業(yè)務(wù)處理，表示層和商業(yè)邏輯層間有多次數(shù)據(jù)交換?！睌?shù)據(jù)層實(shí)際是DBMS，它負(fù)責(zé)管理對數(shù)據(jù)庫的訪問和控制數(shù)據(jù)庫數(shù)據(jù)的讀寫。數(shù)據(jù)層應(yīng)能夠迅速執(zhí)行大量數(shù)據(jù)的更新和檢索操作。本系統(tǒng)采用了先進(jìn)的B/S架構(gòu)，提供分布式應(yīng)用解決方案。系統(tǒng)是以完全基于J2EE標(biāo)準(zhǔn)的電子商務(wù)平臺技術(shù)為基礎(chǔ)創(chuàng)建的純Java的大型電子商務(wù)交易系統(tǒng)，其充分發(fā)揮了Java基于Web的特性和良好跨平臺性，保證了系統(tǒng)良好的可擴(kuò)展性，為實(shí)現(xiàn)向綜合交易平臺的過渡打下基礎(chǔ)。在確保查詢正確的前提下，系統(tǒng)還采用了數(shù)字證書技術(shù)提供可靠的加密/解密、數(shù)字簽名等手段，以保證系統(tǒng)中數(shù)據(jù)傳輸?shù)陌踩?。系統(tǒng)體系結(jié)構(gòu)如下：Plug-insPlug-insWEBLOGICJSPServletServletJSPServletEJBEJBJMSJDBCDBServerApp.JavaMailMailServerIEIEservletJSPJSPservletservletEJBEJBEJB模塊結(jié)構(gòu)設(shè)計(jì)組件模塊總體設(shè)計(jì)主要對整個(gè)系統(tǒng)中公共組件模塊進(jìn)行描述。組件模塊的劃分和功能描述說明本系統(tǒng)的系組件模塊的劃分，扼要說明每個(gè)組件模塊的標(biāo)識符和功能說明模塊ID模塊描述組件模塊關(guān)系主要描述組件模塊和組件模塊之間的調(diào)用關(guān)系。如下圖中組件模塊的物理分布通過物理分布圖描述組件模塊在物理環(huán)境中的分布。示例如下：組件模塊與用例映射列出實(shí)現(xiàn)用例時(shí)需要用到哪些組件模塊，用√表示在實(shí)現(xiàn)某個(gè)用例時(shí)需要調(diào)用某個(gè)組件模塊ModuleIDUseCase組件模塊1組件模塊2組件模塊3組件模塊4組件模塊5。。。用例名√√組件模塊描述描述系統(tǒng)中各個(gè)組件模塊相應(yīng)功能的全部細(xì)節(jié)，要求對每一個(gè)模塊的設(shè)計(jì)都可以被實(shí)現(xiàn)，并能夠被驗(yàn)證的，主要就是描述每一個(gè)組件模塊的輸入、輸出和處理流程，必要時(shí)，可以借助數(shù)據(jù)流圖來描述。組件模塊1組件模塊概述功能說明對模塊功能進(jìn)行總體描述，著重描述該模塊的調(diào)用者，以及調(diào)用者通過該模塊完成什么樣的功能，及描述“做什么”. 前置條件描述運(yùn)行該模塊之前必須滿足的前提條件 后置影響描述運(yùn)行該模塊之后將會產(chǎn)生的影響。子模塊劃分對該模塊劃分成更小的模塊，并對每個(gè)子模塊的功能簡要說明。若該模塊較小，則不必細(xì)分。組件模塊接口設(shè)計(jì)對每個(gè)組件模塊對外提供的方法進(jìn)行描述。方法1方法名方法功能描述輸入?yún)?shù)輸出返回值主要處理邏輯備注對于復(fù)雜的輸入?yún)?shù)需要詳細(xì)描述，描述示例如下：使用xml格式描述完成該子模塊所需要的輸入數(shù)據(jù)格式，同時(shí)要注明哪些數(shù)據(jù)是由用戶輸入的，哪些是數(shù)據(jù)是由系統(tǒng)生成的。同時(shí)還要描述數(shù)據(jù)的具體格式要求，如最大長度，日期型還是整型，小數(shù)精確到幾位等。例如登錄模塊的輸入數(shù)據(jù)格式如下：<login><username>cbx</username><password>1234</password><logintime>2002-6-910:20:9</logintime><clientip>192.168.3.33</clientip></login>數(shù)據(jù)域產(chǎn)生方式數(shù)據(jù)類型最大長度最小長度精確度Username用戶輸入String155Password用戶輸入String156Logintim系統(tǒng)產(chǎn)生DateTime對于復(fù)雜的輸出返回需要詳細(xì)描述，描述示例如下：描述該模塊執(zhí)行后的輸出數(shù)據(jù)，包括成功失敗兩種情況。對失敗要枚舉出各種可能的結(jié)果。如果該輸出格式比較復(fù)雜，建議也用xml格式。example（login）返回值條件登錄成功返回sessionid、基礎(chǔ)數(shù)據(jù)等登錄失敗用戶名和密碼不對；服務(wù)器忙；無效IP地址；你已經(jīng)在線；…對于復(fù)雜的處理邏輯建議適用流程圖或者活動圖來描述用例實(shí)現(xiàn)用例1用例概述用例功能說明對用例功能進(jìn)行總體描述，著重描述該模塊的調(diào)用者，以及調(diào)用者通過該模塊完成什么樣的功能，及描述“做什么”. 用例前置條件描述運(yùn)行該模塊之前必須滿足的前提條件用例后置影響描述運(yùn)行該模塊之后將會產(chǎn)生的影響。用戶界面對于用戶界面的設(shè)計(jì)可以為可選項(xiàng)，如果缺少有關(guān)界面的設(shè)計(jì)描述，將給開發(fā)人員帶來對概要設(shè)計(jì)的二義性時(shí)則要求設(shè)計(jì)界面。界面的設(shè)計(jì)，要求根據(jù)本軟件所事先制訂的有關(guān)界面約定或設(shè)計(jì)規(guī)范，初步畫出各個(gè)用戶的操作界面。用戶界面的貼圖用戶界面的貼圖或輸出報(bào)表樣式界面要素顯示名稱描述約束條件備注操作操作名稱描述約束條件備注流程圖（或活動圖）前后臺交互的數(shù)據(jù)內(nèi)容涉及主要組件模塊和功能模塊列出實(shí)現(xiàn)該用例時(shí)所需要的組件模塊名稱，功能類，文件等等用例實(shí)現(xiàn)類圖時(shí)序圖數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)表名或視圖名[Table_NameorView_Name]ID字段名字段代碼類型和長度字段說明可空缺省值取值范圍鍵值索引接口設(shè)計(jì)為可選項(xiàng)，若存在有關(guān)的接口并且需要特別說明，否則容易產(chǎn)生開發(fā)者對系統(tǒng)設(shè)計(jì)的二義性時(shí)需要詳細(xì)描述。接口分為外部接口和內(nèi)部接口，其中外部接口如：用戶界面、軟件接口與硬件接口等，內(nèi)部接口如：子系統(tǒng)之間的接口關(guān)系，模塊之間的接口，主要是有關(guān)傳遞信息,參數(shù)等等。本章若存在N個(gè)接口，則可分為N節(jié)來描述，每個(gè)接口單獨(dú)為一節(jié)，標(biāo)題可自行決定。系統(tǒng)安全設(shè)計(jì)為可選項(xiàng)，如果系統(tǒng)設(shè)計(jì)對安全保密性有特別的要求，則需要詳細(xì)描述，主要可以從以下幾方面進(jìn)行考慮：系統(tǒng)故障預(yù)防與恢復(fù)、用戶管理和權(quán)限控制、數(shù)據(jù)備份和恢復(fù)等系統(tǒng)故障預(yù)防和恢復(fù)為可選項(xiàng)，如果存在可能出現(xiàn)的系統(tǒng)故障需要恢復(fù)的情況，則要進(jìn)行設(shè)計(jì)描述，主要說明將使用的恢復(fù)再啟動技術(shù)，使軟件從故障點(diǎn)恢復(fù)執(zhí)行或使軟件從頭開始重新運(yùn)行的方法，建議可按照以下格式進(jìn)行說明：為恢復(fù)系統(tǒng)（包括軟硬件）故障和人為因素引起的數(shù)據(jù)錯(cuò)，特設(shè)計(jì)以下措施：出錯(cuò)現(xiàn)象可能原因措施盤后清算出現(xiàn)異常本地柜臺的交易數(shù)據(jù)出錯(cuò)恢復(fù)昨日盤后數(shù)據(jù)，重新接受交易所當(dāng)日委托數(shù)據(jù)，重新進(jìn)行清算用戶管理和權(quán)限控制說明在數(shù)據(jù)庫的設(shè)計(jì)中，將如何通過區(qū)分不同的訪問者、不同的訪問類型和不同的數(shù)據(jù)對象，進(jìn)行分配權(quán)限并分別對待而獲得的數(shù)據(jù)庫安全保密的設(shè)計(jì)考慮。數(shù)據(jù)備份與恢復(fù)為可選項(xiàng)，如果存在數(shù)據(jù)備份與恢復(fù)的需求要求，則要做相應(yīng)的設(shè)計(jì)描述。對數(shù)據(jù)備份與恢復(fù)的設(shè)計(jì)，主要說明在適當(dāng)?shù)臅r(shí)間點(diǎn)上，如何設(shè)計(jì)系統(tǒng)的數(shù)據(jù)備份和數(shù)據(jù)恢復(fù)功能，以便在系統(tǒng)失效、出現(xiàn)意外及數(shù)據(jù)出錯(cuò)、或有充分的需要的時(shí)候，可以在可接受的時(shí)間內(nèi)得以恢復(fù)到最近或以前某個(gè)時(shí)間點(diǎn)的數(shù)據(jù)備份上，要求描述清楚實(shí)現(xiàn)數(shù)據(jù)備份和恢復(fù)的整個(gè)設(shè)計(jì)思想以及實(shí)現(xiàn)方法。數(shù)據(jù)備份系統(tǒng)是一套24小時(shí)實(shí)時(shí)運(yùn)行的加以系統(tǒng)，數(shù)據(jù)庫中存儲的數(shù)據(jù)大部分是非常重要的商業(yè)交易數(shù)據(jù)，它要求高度的安全性和強(qiáng)健的完整性，所以，必須制定功能完善的數(shù)據(jù)備份策略，充分保證數(shù)據(jù)庫系統(tǒng)的安全和完整。為此制定以下安全備份措施：所有交易數(shù)據(jù)庫，全部對應(yīng)建立歷史備份數(shù)據(jù)庫，定期將當(dāng)前數(shù)據(jù)庫中的數(shù)據(jù)追加到歷史數(shù)據(jù)庫中。對歷史數(shù)據(jù)庫中的數(shù)據(jù)，定期備份。一般當(dāng)前數(shù)據(jù)，每月一次自動復(fù)制到歷史數(shù)據(jù)庫中；歷史數(shù)據(jù)保留半年后，使用光盤刻錄設(shè)備，進(jìn)行2份以上備份存檔，然后可清除歷史數(shù)據(jù)庫和當(dāng)前數(shù)據(jù)庫中的這部份數(shù)據(jù)，以提高系統(tǒng)運(yùn)行效率，釋放部分硬件資源。主數(shù)據(jù)庫服務(wù)器使用磁帶備份系統(tǒng)，對數(shù)據(jù)庫中的實(shí)時(shí)數(shù)據(jù)作更新備份和增量備份（不包括歷史庫）。數(shù)據(jù)庫日備份：系統(tǒng)每日自動將更新操作后的數(shù)據(jù)備份到磁帶機(jī)上。數(shù)據(jù)庫周備份：每周一次，系統(tǒng)自動將所有數(shù)據(jù)庫備份到磁帶機(jī)上。數(shù)據(jù)庫月備份：每月一次，系統(tǒng)自動備份所有數(shù)據(jù)庫到磁帶機(jī)上。主數(shù)據(jù)庫服務(wù)器使用跟蹤帶，對系統(tǒng)操作進(jìn)行跟蹤記錄。數(shù)據(jù)恢復(fù)數(shù)據(jù)的恢復(fù)措施主要與數(shù)據(jù)備份相對應(yīng)：如果當(dāng)前數(shù)據(jù)庫因故遭到破壞，不能保證其完整性時(shí)，應(yīng)進(jìn)行恢復(fù)。步驟如下：先將歷史庫中的數(shù)據(jù)追加到當(dāng)前庫中。將磁帶上的數(shù)據(jù)按月備份、周備份、日備份的順序，依次恢復(fù)到當(dāng)前數(shù)據(jù)庫中。按照跟蹤帶上的操作順序，將當(dāng)天的數(shù)據(jù)進(jìn)行恢復(fù)?？筛鶕?jù)具體情況選擇其中的若干步執(zhí)行。如需查詢歷史數(shù)據(jù)，可將光盤中部分或全部歷史數(shù)據(jù)，重新導(dǎo)入數(shù)據(jù)庫中。系統(tǒng)運(yùn)行設(shè)計(jì)為可選項(xiàng)，當(dāng)系統(tǒng)足夠大被拆分成若干子系統(tǒng)，如果不專門介紹系統(tǒng)運(yùn)行時(shí)各子系統(tǒng)之間的運(yùn)行機(jī)制和控制關(guān)系，則開發(fā)人員無法理解本概要設(shè)計(jì)說明書而導(dǎo)致無法實(shí)現(xiàn)系統(tǒng)功能時(shí)，才有必要進(jìn)行相關(guān)運(yùn)行設(shè)計(jì)的描述。運(yùn)行設(shè)計(jì)，主要用來說明運(yùn)行模塊的組合，進(jìn)行軟件系統(tǒng)的構(gòu)造設(shè)計(jì)，確定系統(tǒng)的運(yùn)行控制方法及資源分配情況運(yùn)行模塊組合說明對系統(tǒng)施加不同的外界運(yùn)行控制時(shí)所引起的各種不同的運(yùn)行模塊組合，說明每種運(yùn)行所歷經(jīng)的內(nèi)部模塊和支持軟件，建議畫出系統(tǒng)運(yùn)行機(jī)制結(jié)構(gòu)圖來表示，再附上簡要的文字說明，以描述清楚各個(gè)運(yùn)行模塊（包括各種運(yùn)行的進(jìn)程），分別如何運(yùn)行在各自指定的硬件上（必要時(shí)要說明相關(guān)的硬件配置及其在運(yùn)行環(huán)境下所起的作用）運(yùn)行控制描述清楚各個(gè)運(yùn)行模塊進(jìn)行運(yùn)行控制的方式、方法和操作步驟，以及每種運(yùn)行模塊組合將各自占用的各種資源情況，以及對時(shí)間響應(yīng)的要求，可以分別從以下幾方面進(jìn)行描述：多機(jī)管理，一臺服務(wù)器應(yīng)允許多臺客戶端機(jī)器加入應(yīng)用系統(tǒng)，則要描述清楚服務(wù)器是如何進(jìn)行管理多臺機(jī)器的。合法性檢查，當(dāng)客戶端需要訪問后臺數(shù)據(jù)庫的業(yè)務(wù)數(shù)據(jù)時(shí)，有關(guān)應(yīng)用系統(tǒng)的網(wǎng)關(guān)服務(wù)或其他相關(guān)服務(wù)程序是如何進(jìn)行用戶身份的合法性校驗(yàn)，一般系統(tǒng)都會要求每一個(gè)用戶發(fā)出某個(gè)服務(wù)請求后，必須首先輸入自己的用戶名和密碼請求響應(yīng)，有關(guān)服務(wù)器對用戶的各種請求的響應(yīng)，采用多線程的并發(fā)處理還是單線程的串行順序處理等方式的實(shí)現(xiàn)情況，以及對事務(wù)處理的時(shí)間響應(yīng)要求等控制界面，關(guān)于用戶監(jiān)控系統(tǒng)（如：國泰君安實(shí)時(shí)監(jiān)控系統(tǒng)）的監(jiān)控屏幕上應(yīng)該顯示各種業(yè)務(wù)處理信息，出現(xiàn)異常時(shí)要求要實(shí)時(shí)報(bào)警或做相應(yīng)妥善的處理。通訊控制，描述清楚系統(tǒng)所采納的通訊平臺的有關(guān)說明，包括前臺和后臺之間的通訊、網(wǎng)關(guān)之間的數(shù)據(jù)轉(zhuǎn)換處理，以及通訊時(shí)所采用的通訊協(xié)議等內(nèi)容核心業(yè)務(wù)處理，說明對客戶的許多關(guān)鍵或主要業(yè)務(wù)的系統(tǒng)實(shí)現(xiàn)，在整個(gè)運(yùn)行機(jī)制中是如何進(jìn)行控制的系統(tǒng)出錯(cuò)處理設(shè)計(jì)為可選項(xiàng)，如果不專門對系統(tǒng)出錯(cuò)信息進(jìn)行設(shè)計(jì)描述，將導(dǎo)致開發(fā)人員無法理解本概要設(shè)計(jì)的有關(guān)出錯(cuò)信息的處理說明，無法實(shí)現(xiàn)有關(guān)出錯(cuò)處理功能時(shí)，才需要描述本章節(jié)的內(nèi)容出錯(cuò)處理信息羅列本軟件系統(tǒng)可能的出錯(cuò)或故障情況出現(xiàn)的各種出錯(cuò)處理信息，包括系統(tǒng)出錯(cuò)信息提示的形式（包括出錯(cuò)對話框的設(shè)計(jì)）、含義及處理方法等。在操作出錯(cuò)或數(shù)據(jù)出錯(cuò)等情況下，系統(tǒng)顯示或記錄的有關(guān)出錯(cuò)代碼／信息，要求要符合相關(guān)的《系統(tǒng)出錯(cuò)處理設(shè)計(jì)規(guī)范》（如果規(guī)范存在的話）出錯(cuò)的分類可以參考以下：通訊線路錯(cuò)誤系統(tǒng)環(huán)境錯(cuò)誤應(yīng)用設(shè)計(jì)錯(cuò)誤出錯(cuò)處理對策說明故障出現(xiàn)或系統(tǒng)出錯(cuò)后可能采取的變通補(bǔ)救辦法，主要包括：設(shè)置后備技術(shù)、性能降級（即降效技術(shù)）、恢復(fù)及再啟動等等。設(shè)置后備技術(shù)，體現(xiàn)在：當(dāng)原始系統(tǒng)數(shù)據(jù)萬一丟失時(shí)則啟用的副本的建立或啟動的技術(shù)，采用磁帶備份等降效技術(shù)，也是一種后備技術(shù)，體現(xiàn)在：使用另一種效率稍低的系統(tǒng)或方法求得所需結(jié)果的某些部分，如手工操作。下述為對于系統(tǒng)環(huán)境出錯(cuò)處理對策參考：系統(tǒng)故障根據(jù)系統(tǒng)類型可分為四類：系統(tǒng)軟件故障、應(yīng)用軟件故障、硬件系統(tǒng)故障、網(wǎng)絡(luò)系統(tǒng)故障。系統(tǒng)維護(hù)工作的進(jìn)行，應(yīng)建立在對系統(tǒng)正常按章操作的基礎(chǔ)上，把人為損壞的因素降到最低。因此，良好和規(guī)范的操作習(xí)慣是保證系統(tǒng)穩(wěn)定運(yùn)行的重要保障。系統(tǒng)類型故障類型維護(hù)措施系統(tǒng)軟件UNIX系統(tǒng)故障·設(shè)置專職系統(tǒng)管理員·UNIX系統(tǒng)故障類型較多，具體故障對應(yīng)具體的處理辦法，不能一一列舉。但在系統(tǒng)安裝設(shè)置完成后，應(yīng)及時(shí)備份主要系統(tǒng)文件，編制一