XXX系統(tǒng)V e r X.X概要設(shè)計(jì)說(shuō)明書(shū)

e r 檔目的 簡(jiǎn)要說(shuō)明編寫(xiě)這份概要設(shè)計(jì)說(shuō)明書(shū)的目的，指出預(yù)期的讀者。 本概要設(shè)計(jì)說(shuō)明書(shū)的編寫(xiě)目的是為了說(shuō)明系統(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ì)說(shuō)明書(shū)的適用讀者為：軟件開(kāi)發(fā)者、測(cè)試人員。 目概述 發(fā)單位、協(xié)作單位、用戶單位 述該項(xiàng)軟件開(kāi)發(fā)的意圖、應(yīng)用目標(biāo)、作用范圍以及其他應(yīng)向讀者說(shuō)明的有關(guān)該軟件開(kāi)發(fā)的背景材料。如果本次開(kāi)發(fā)的軟件系統(tǒng)是一個(gè)更大的系統(tǒng)的一個(gè)組成部分，則要說(shuō)明該更大系統(tǒng)的組成和介紹本系統(tǒng)與其它相關(guān)系統(tǒng)的關(guān)系和接口部分 本項(xiàng)為可選項(xiàng)，一般的軟件公司都會(huì)要求對(duì)軟件開(kāi)發(fā)的概要設(shè)計(jì)文檔進(jìn)行保密，不允許被復(fù)制、使用和擴(kuò)散到公司之外的范圍，如果需要強(qiáng)調(diào)則允許做相關(guān)的保密說(shuō)明 本項(xiàng)為可選項(xiàng)， 若有必要，才要作有關(guān)的描述。 考資料 列出編寫(xiě)本報(bào)告時(shí)參考的文件 (如經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同、上級(jí)機(jī)關(guān)的批文等 )、資料、技術(shù)標(biāo)準(zhǔn)，以及他們的作者、標(biāo)題、編號(hào)、發(fā)布日期和出版單位。這些文件主要包括： 本軟件開(kāi)發(fā)所經(jīng)核準(zhǔn)的合同或標(biāo)書(shū)或可行性報(bào)告等文檔 軟件開(kāi)發(fā)計(jì)劃書(shū) 需求分析報(bào)告 統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 2頁(yè) 測(cè)試方案（若存在初稿的話） 與本項(xiàng)目有關(guān)的已發(fā)表的文件或資料 本文件中各處引用的文件、資料，所采用的軟件開(kāi)發(fā)標(biāo)準(zhǔn)和規(guī)范 編號(hào) 資料名稱(chēng) 簡(jiǎn)介 作者 日期 出版單位 列出編寫(xiě)本報(bào)告時(shí)查閱的 雜志、專(zhuān)業(yè)著作、技術(shù)標(biāo)準(zhǔn)以及他們的網(wǎng)址。 網(wǎng) 站 簡(jiǎn) 介 語(yǔ)定義 列出本文檔中所引用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和首字母縮寫(xiě)詞、縮略語(yǔ)的原文，以便對(duì)概要設(shè)計(jì)說(shuō)明書(shū)進(jìn)行適當(dāng)?shù)慕忉?改記錄 編號(hào) 修改內(nèi)容描述 修改人 審核人 批準(zhǔn)人 修改日期 備注 統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 3頁(yè) 2. 系統(tǒng)概述 概要地介紹本軟件系統(tǒng)，只要求提供影響設(shè)計(jì)的一般因素，不必太詳細(xì)地描述大量細(xì)節(jié)，本章主要目的僅僅是使本設(shè)計(jì)說(shuō)明書(shū)更加易于理解，建議根據(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) 說(shuō)明完成本項(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ì)或開(kāi)發(fā)受到某種特定 的限制，或者可直接能影響系統(tǒng)設(shè)計(jì)的某種因素，這些因素可能成為系統(tǒng)的設(shè)計(jì)約束，他們的改變可能會(huì)影響某些需求的實(shí)現(xiàn)時(shí)，才需要做概要介紹。 若存在以下方面的系統(tǒng)約束或條件限制時(shí)，可以進(jìn)行相關(guān)的闡明：（但不限于這些） 1. 為完成本軟件系統(tǒng)應(yīng)具備的特定條件、開(kāi)發(fā)單位已具備的條件以及尚需創(chuàng)造的條件 ,如：現(xiàn)階段還未到位的設(shè)備、資源等需要做出相應(yīng)的約束說(shuō)明 2. 必要時(shí)，還應(yīng)說(shuō)明用戶及分合同承包者承擔(dān)的工作、完成期限及其他條件與限制，如果用戶及分合同承包者對(duì)系統(tǒng)的實(shí)現(xiàn)起到的某些作用會(huì)直接影響系統(tǒng)設(shè)計(jì)的成敗則要特別說(shuō)明 3. 本系統(tǒng)的設(shè)計(jì)規(guī)范需要受到某些特定的行業(yè)規(guī)范的限制 4. 本系統(tǒng)的開(kāi)發(fā)需要受到用戶對(duì)系統(tǒng)的工程化管理的某些特別的要求，包括用戶規(guī)定對(duì)系統(tǒng)實(shí)現(xiàn)的全過(guò)程的變更規(guī)定 5. 本系統(tǒng)設(shè)計(jì)工作所需的一些假定條件和必須滿足的約束，如本功能的開(kāi)發(fā)假定用戶會(huì)熟練使用 言，本功能的實(shí)現(xiàn)應(yīng)該在某功能實(shí)現(xiàn)前開(kāi)發(fā)完成等 6. 本系統(tǒng)的設(shè)計(jì)可能需要使用的所有購(gòu)入構(gòu)件、所有適用的許可或使用限制，統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 4頁(yè) 以及所有相關(guān)的兼容性及互操作性或接口標(biāo)準(zhǔn)的有關(guān)限制和規(guī)定 行環(huán)境 概要地說(shuō)明本軟件系統(tǒng)的運(yùn)行環(huán)境的拓樸結(jié)構(gòu)和布局，分別說(shuō)明前、后臺(tái)及網(wǎng)關(guān)或中間件的運(yùn)行環(huán)境 , 應(yīng)包括通訊條件、網(wǎng)絡(luò)環(huán)境、硬件配置、軟件系統(tǒng)等 其中硬件環(huán)境：要求列出為運(yùn)行本軟件所要求的硬件最小配置： 處理器的型號(hào)、內(nèi)存容量 所要求的硬盤(pán)空間、分區(qū)格式、相關(guān)的記錄格式、設(shè)備的型號(hào)和數(shù)量、聯(lián)機(jī) /脫機(jī)等 I/O 設(shè)備（聯(lián)機(jī) /脫機(jī)） 網(wǎng)絡(luò)相關(guān)設(shè)備（型號(hào)、數(shù)量） 支持軟件：說(shuō)明為運(yùn)行本軟件所需要的支持軟件，如： 操作系統(tǒng)名稱(chēng)、對(duì)應(yīng)的版本號(hào)、相關(guān)的 編譯器和對(duì)應(yīng)的版本號(hào) 數(shù)據(jù)庫(kù)管理系統(tǒng)和對(duì)應(yīng)版本號(hào) 其他支持軟件 這里只要求概要的說(shuō)明一下，以便幫助理解本概 要設(shè)計(jì)說(shuō)明書(shū)，可參考以下格式： 【前臺(tái)】 計(jì)算機(jī)： C 兼容機(jī)。 操作系統(tǒng)： 7/98/2000/作系統(tǒng) 數(shù)據(jù)庫(kù)系統(tǒng)： 據(jù)庫(kù)系統(tǒng)（客戶端） 應(yīng)用軟件： 戶端） 網(wǎng)絡(luò)： P 【后臺(tái)】 計(jì)算機(jī)： S/6000 操作系統(tǒng)： 作系統(tǒng) 數(shù)據(jù)庫(kù)系統(tǒng)： 據(jù)庫(kù)系統(tǒng)（服務(wù)端） 應(yīng)用軟件： 務(wù)端） 網(wǎng)絡(luò)： P 3. 需求概述 根據(jù)系統(tǒng)設(shè)計(jì)的實(shí)際需要，簡(jiǎn)要介紹系統(tǒng)的需求情況，不必詳細(xì)描述需求的具體細(xì)節(jié)，只僅僅要求能夠更好幫助理解本設(shè)計(jì)說(shuō)明書(shū)的內(nèi)容，建議有選擇地從功能需求、性能需求和運(yùn)行需求進(jìn)行分別描述，對(duì)于直接影響系統(tǒng)設(shè)計(jì)的關(guān)鍵或統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 5頁(yè) 主要功能、性能以及運(yùn)行要求等方面進(jìn)行概要介紹，如果性能和運(yùn)行需求方面對(duì)設(shè)計(jì)影響不大，則允許不必說(shuō)明 總體描述 對(duì)系統(tǒng)的整體需求進(jìn)行概述 系統(tǒng)角色 描述系統(tǒng)的用戶，權(quán)限等 寫(xiě) 名稱(chēng) 描述 英語(yǔ)簡(jiǎn)稱(chēng) 系統(tǒng)功能 功能劃分 對(duì)系統(tǒng)進(jìn)行功能劃分 用例清單 根據(jù)劃分，列出各個(gè)功能模塊 功能 能名稱(chēng) 系統(tǒng)角色使用權(quán)限 描 述 列出所有系統(tǒng)角色，并用 表示具有相應(yīng)權(quán)限 性能和運(yùn)行需求 4. 總體設(shè)計(jì) 計(jì)原則 介紹本系統(tǒng)的結(jié)構(gòu)設(shè)計(jì)原則和總體設(shè)計(jì)指導(dǎo)思想，主要從系統(tǒng)設(shè)計(jì)實(shí)現(xiàn)的目統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 6頁(yè) 標(biāo)來(lái)考慮，比如：處理速度、安全保密性、可擴(kuò)展性等方面進(jìn)行闡述，可以使用一些套話稍做修改即可。建議參考以下范例進(jìn)行描述： 數(shù)據(jù)實(shí)時(shí)性強(qiáng) 監(jiān)控的實(shí)時(shí)性是不言而喻的。無(wú)論實(shí)時(shí)檢測(cè)還是動(dòng)態(tài)顯示交易匯總數(shù)據(jù)和盤(pán)中異常結(jié)果，都要求實(shí)時(shí)監(jiān)控的算法盡量?jī)?yōu)化，處理簡(jiǎn)潔，這樣才能真正達(dá)到實(shí)時(shí)監(jiān)控的目的，為總部進(jìn)行盤(pán)中稽核和及時(shí)處理異常情況提供有效的手段。 可擴(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)的接口。 可維護(hù)性好 由于證券市場(chǎng)、政策及其管理是隨著整個(gè)國(guó)民經(jīng)濟(jì)的發(fā)展而變化的，要求對(duì)交易業(yè)務(wù)的實(shí)時(shí)監(jiān)控具有相當(dāng)?shù)撵`活性，以便于維護(hù)。 先進(jìn)性 系 統(tǒng)采用國(guó)際流行的 放式框架，主要軟硬件設(shè)備符合國(guó)際標(biāo)準(zhǔn)，集成了國(guó)際水平的主流生產(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ī)器的任何操作都通過(guò)服務(wù)器來(lái)實(shí)現(xiàn)其一致性和完整性控制。數(shù)據(jù)庫(kù)及財(cái)務(wù)稽核系統(tǒng)本身都應(yīng)提供分級(jí)授權(quán)、日志記錄等手段來(lái)確保系統(tǒng)的安全。 計(jì)規(guī)范 說(shuō)明可以引用公司現(xiàn)有的各種設(shè)計(jì)規(guī)范或各種軟件開(kāi)發(fā)的國(guó)家標(biāo)準(zhǔn)或規(guī)范，主要包括：（不限于以下幾種，也不指定） 命名約定 規(guī)定系統(tǒng)和子系統(tǒng)名 , 程序名 , 數(shù)據(jù)庫(kù)表 (文件 )名 , 數(shù)據(jù)名 , 變量名等的編制規(guī)范。 界面約定 規(guī)定屏幕界面的總體布局，如菜單行、顯示主體、圖標(biāo)按鈕、提示信息、出錯(cuò)信息等規(guī)范化，統(tǒng)一風(fēng)格。 程序編寫(xiě)規(guī)范 根據(jù)采用的編程工具特點(diǎn)，制定規(guī)范化要求，使程序易讀易懂，可維護(hù)，可移植。 具體選用的規(guī)范，只要對(duì)設(shè)計(jì)有所幫助就可以羅列，編號(hào)及相關(guān)規(guī)范標(biāo)題可以自行決定。 對(duì)于引用公司事先制訂的有關(guān)規(guī)范或現(xiàn)存的各種國(guó)家標(biāo)準(zhǔn)等規(guī)范，則可以簡(jiǎn)單地描述，并參見(jiàn) 范或標(biāo)準(zhǔn)，文件可以作為本概要設(shè)計(jì)說(shuō)明書(shū)的附件進(jìn)行保存 統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 7頁(yè) 如果一個(gè)系統(tǒng)比 較大需要拆分成若干個(gè)子系統(tǒng)，而每個(gè)子系統(tǒng)需要各自編制概要設(shè)計(jì)文檔，則只需要在一個(gè)總的概要設(shè)計(jì)說(shuō)明書(shū)進(jìn)行描述，其他子系統(tǒng)允許不專(zhuān)門(mén)進(jìn)行描述，或注明參見(jiàn) 要設(shè)計(jì)說(shuō)明書(shū)。 件體系結(jié)構(gòu) 簡(jiǎn)要介紹系統(tǒng)的總體結(jié)構(gòu)和概要功能，可以通過(guò)畫(huà)系統(tǒng)設(shè)計(jì)總體框架結(jié)構(gòu)圖的方式，再附上簡(jiǎn)單的文字說(shuō)明 ,對(duì)本軟件系統(tǒng)的總體功能進(jìn)行概要描述。對(duì)于采用 臺(tái)的系統(tǒng)，參考如下： 系統(tǒng)的體系架構(gòu)是一個(gè)系統(tǒng)的骨架，其重要性對(duì)一個(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)中，我們將遵循 范進(jìn)行設(shè)計(jì)和開(kāi)發(fā)。 系結(jié)構(gòu)由 定義了如何開(kāi)發(fā)、配置及實(shí)現(xiàn)一個(gè)企業(yè)應(yīng)用，提供了對(duì) 及 術(shù)的全面支持。 供了一個(gè)企業(yè)級(jí)的計(jì)算模型和運(yùn)行環(huán)境，用于開(kāi)發(fā)和部署多層體系結(jié)構(gòu)的應(yīng)用。它通過(guò)提供企業(yè)計(jì)算環(huán)境所必須的各種服務(wù)，使得部署在 臺(tái)上的多層應(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)用間的對(duì)話功能。它可用于檢查用戶從鍵盤(pán)等輸入的數(shù)據(jù)，顯示系統(tǒng)處理后輸出的數(shù)據(jù)。 在變更用戶接口時(shí)，只需要改寫(xiě)顯示控制和數(shù)據(jù)檢查程序，而并不會(huì)因此影響其他層的功能。而數(shù)據(jù)檢查的功能也只是限于數(shù)據(jù)的形式和實(shí)際取值范圍，不包括有關(guān)業(yè)務(wù)本身的處理邏輯。另外圖形界面的結(jié)構(gòu)也是不固定的，這便于以后統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 8頁(yè) 可靈活變更。例如：可以在一個(gè)窗口中不是放入幾個(gè)功能，而是按照功能分割窗口，以便每個(gè)窗口的功能簡(jiǎn)潔。 在原有 C/業(yè)邏輯層實(shí)際是整個(gè)應(yīng)用的本體，它負(fù)責(zé)整個(gè)系統(tǒng)的業(yè)務(wù)處理邏輯。表示層和商業(yè)邏輯層間的數(shù)據(jù)交換盡量簡(jiǎn)潔，避免“一次業(yè)務(wù)處理，表示層和商業(yè)邏輯層間有多次數(shù)據(jù)交換?！?數(shù)據(jù)層實(shí)際是 負(fù)責(zé)管理對(duì)數(shù)據(jù)庫(kù) 的訪問(wèn)和控制數(shù)據(jù)庫(kù)數(shù)據(jù)的讀寫(xiě)。數(shù)據(jù)層應(yīng)能夠迅速執(zhí)行大量數(shù)據(jù)的更新和檢索操作。 本系統(tǒng)采用了先進(jìn)的 B/S 架構(gòu)，提供分布式應(yīng)用解決方案。系統(tǒng)是以完全基于 準(zhǔn)的電子商務(wù)平臺(tái)技術(shù)為基礎(chǔ)創(chuàng)建的純 大型電子商務(wù)交易系統(tǒng)，其充分發(fā)揮了 證了系統(tǒng)良好的可擴(kuò)展性，為實(shí)現(xiàn)向綜合交易平臺(tái)的過(guò)渡打下基礎(chǔ)。在確保查詢正確的前提下，系統(tǒng)還采用了數(shù)字證書(shū)技術(shù)提供可靠的加密 /解密、數(shù)字簽名等手段，以保證系統(tǒng)中數(shù)據(jù)傳輸?shù)陌踩浴Ｏ到y(tǒng)體系結(jié)構(gòu)如下： 5. 模塊結(jié)構(gòu)設(shè)計(jì) 件模塊總體設(shè)計(jì) 主要對(duì)整個(gè)系統(tǒng)中公共組件模塊進(jìn)行描述。 組件模塊的劃分和功能描述 說(shuō)明本系統(tǒng)的系組件模塊的劃分，扼要說(shuō)明每個(gè)組件模塊的標(biāo)識(shí)符和功能說(shuō)B E IE SP 統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 9頁(yè) 明 模塊 塊 描 述 1. 組件模塊關(guān)系 主要描述組件模塊和組件模塊之間的調(diào)用關(guān)系。如下圖中 組件模塊的物理分布 通過(guò)物理分布圖描述組件模塊在物理環(huán)境中的分布。示例如下： E n cr y p t / D e cr y p t n cr y p t / D e cr y p t A e r t M a n a g e m e n A A r r o r H a n d l i n gg l o b a lI n f o P a r si n gO n l i n e U se r M a n a g e m e n tC o m m o n C o n n e I n t e r f a p p li ca t i o n sD e sk t o p n c r y p t / D e c r y p t N TC e r t M a n a g e m e n b S e r v e rA p p l i c a t i o n sC o m m o n C o n n e c t I n t e r f a c A c c e s sE n c r y p t / D e c r y p t A I A c c e s sE r r o r H a n d l i n gO n l i n e U s e r M a n a g e m e n tI n f o P a r s i n F r o n t M a ch i n ND e sk t o p n c r y p t / D e c r y p t N TC e r t M a n a g e m e n 統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 10頁(yè) 組件模塊與用例映射 列出實(shí)現(xiàn)用例時(shí)需要用到哪些組件模塊，用 表示在實(shí)現(xiàn)某個(gè)用例時(shí)需要調(diào)用某個(gè)組件模塊 D 件 模塊 1 組件 模塊 2 組件 模塊 3 組件 模塊 4 組件 模塊 5 。 用例名 件模塊描述 描述系統(tǒng)中各個(gè)組件模塊相應(yīng)功能的全部細(xì)節(jié)，要求對(duì)每一個(gè)模塊的設(shè)計(jì)都可以被實(shí)現(xiàn)，并能夠被驗(yàn)證的，主要就是描述每一個(gè)組件模塊的輸入、輸出和處理流程，必要時(shí)，可以借助數(shù)據(jù)流圖來(lái)描述。 組件模塊 1 1. 組件模塊概述 功能說(shuō)明 對(duì)模塊功能進(jìn)行總體描述，著重描述該模塊的調(diào)用者，以及調(diào)用者通過(guò)該模塊完成什么樣的功能，及描述“做什么” . 前置條件 描述運(yùn)行該模塊之前必須滿足的前提條件 后置影響 描述運(yùn)行該模塊之后將會(huì)產(chǎn)生的影響。 子模塊劃分 對(duì)該模塊劃分成更小的模塊，并對(duì)每個(gè)子模塊的功能簡(jiǎn)要說(shuō)明。若該模塊較小，則不必細(xì)分。 2. 組件模塊接口設(shè)計(jì) 對(duì)每個(gè)組件模塊對(duì)外提供的方法進(jìn)行描述。 方法 1 方法名 方法功能描述 輸入?yún)?shù) 輸出返回值 主要處理邏輯 備注 對(duì)于復(fù)雜的輸入?yún)?shù)需要詳細(xì)描述，描述示例如下： 統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 11頁(yè) 使用 式描述完成該子模塊所需要的輸入數(shù)據(jù)格式，同時(shí)要注明哪些數(shù)據(jù)是由用戶輸入的，哪些是數(shù)據(jù)是由系統(tǒng)生成的。同時(shí)還要描述數(shù)據(jù)的具體格式要求，如最大長(zhǎng)度，日期型還是整型，小數(shù)精確到幾位等。例如登錄模塊的輸入數(shù)據(jù)格式如下： 234 20020:20:9 據(jù)域 產(chǎn)生方式 數(shù)據(jù)類(lèi)型 最大長(zhǎng)度 最小長(zhǎng)度 精確度 戶輸入 5 5 戶輸入 5 6 統(tǒng)產(chǎn)生 對(duì)于復(fù)雜的輸出返回需要詳細(xì)描述，描述示例如下： 描述該模塊執(zhí)行后的輸出數(shù)據(jù)，包括成功失敗兩種情況。對(duì)失敗要枚舉出各種可能的結(jié)果。如果該輸出格式比較復(fù)雜，建議也用 式。 返回值 條 件 登錄成功 返回 礎(chǔ)數(shù)據(jù)等 登錄失敗 用戶名和密碼不對(duì)； 服務(wù)器忙； 無(wú)效 址； 你已經(jīng)在線； 對(duì)于復(fù)雜的處理邏輯建議適用流程圖或者活動(dòng)圖來(lái)描述 6. 用例實(shí)現(xiàn) 例 1 1. 用例概述 用例功能說(shuō)明 對(duì)用例功能進(jìn)行總體描述，著重描述該模塊的調(diào)用者，以及調(diào)用者通過(guò)該模塊完成什么樣的功能，及描述“做什么” . 用例前置條件 統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 12頁(yè) 描述運(yùn)行該模塊之前必須滿足的前提條件 用例后置影響 描述運(yùn)行該模塊之后將會(huì)產(chǎn)生的影響。 2. 用戶界面 對(duì)于用戶界面的設(shè)計(jì)可以為可選項(xiàng)，如果缺少有關(guān)界面的設(shè)計(jì)描述，將給開(kāi)發(fā)人員帶來(lái)對(duì)概要設(shè)計(jì)的二義性時(shí)則要求設(shè)計(jì)界面。界面的設(shè)計(jì)，要求根據(jù)本軟件所事先制訂的有關(guān)界面約定或設(shè)計(jì)規(guī)范，初步畫(huà)出各個(gè)用戶的操作界面。 界面要素 顯示名稱(chēng) 描述 約束條件 備注 1） 操作 操作名稱(chēng) 描述 約束條件 備注 3. 流程圖（或活動(dòng)圖） 4. 前后臺(tái)交互的數(shù)據(jù)內(nèi)容 5. 涉及主要組件模塊和功能模塊 列出實(shí)現(xiàn)該用例時(shí)所需要的組件模塊名稱(chēng)，功能類(lèi)，文件等等 6. 用例實(shí)現(xiàn) 1） 類(lèi)圖 2） 時(shí)序圖 用戶界面的貼圖 或輸出報(bào)表樣式 統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 13頁(yè) 7. 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) 表名或視圖名 段名 字段代碼 類(lèi)型和長(zhǎng)度 字段說(shuō)明 可空 缺省值 取值范圍 鍵值 索引 8. 接口設(shè)計(jì) 為可選項(xiàng)，若存在有關(guān)的接口并且需要特別說(shuō)明，否則容易產(chǎn)生開(kāi)發(fā)者對(duì)系統(tǒng)設(shè)計(jì)的二義性時(shí)需要詳細(xì)描述。 接口分為外部接口和內(nèi)部接口，其中外部接口如：用戶界面、軟件接口與硬件接口等，內(nèi)部接口如：子系統(tǒng)之間的接口關(guān)系，模塊之間的接口，主要是有關(guān)傳遞信息 , 參數(shù)等等。 本章若存在 N 個(gè)接口，則可分為 N 節(jié)來(lái)描述，每個(gè)接口單獨(dú)為一節(jié)，標(biāo)題可自行決定。 9. 系統(tǒng)安全設(shè)計(jì) 為可選項(xiàng)，如果系統(tǒng)設(shè)計(jì)對(duì)安全保密性有特別的要求，則需要詳細(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ì)描述，主要說(shuō)明將使用的恢 復(fù)再啟動(dòng)技術(shù)，使軟件從故障點(diǎn)恢復(fù)執(zhí)行或使軟件從頭開(kāi)始重新運(yùn)行的方法，建議可按照以下格式進(jìn)行說(shuō)明： 為恢復(fù)系統(tǒng)（包括軟硬件）故障和人為因素引起的數(shù)據(jù)錯(cuò)，特設(shè)計(jì)以下措施： 出錯(cuò)現(xiàn)象 可能原因 措施 盤(pán)后清算出現(xiàn)異常 本地柜臺(tái)的交易數(shù)據(jù)出錯(cuò) 恢復(fù)昨日盤(pán)后數(shù)據(jù)，重新接受交易所當(dāng)日委托數(shù)據(jù)，重新進(jìn)行清算 統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 14頁(yè) 戶管理和權(quán)限控制 說(shuō)明在數(shù)據(jù)庫(kù)的設(shè)計(jì)中，將如何通過(guò)區(qū)分不同的訪問(wèn)者、不同的訪問(wèn)類(lèi)型和不同的數(shù)據(jù)對(duì)象，進(jìn)行分配權(quán)限并分別對(duì)待而獲得的數(shù)據(jù)庫(kù)安全保密的設(shè)計(jì)考慮。 據(jù)備份與恢復(fù) 為可選項(xiàng)，如果存在數(shù)據(jù)備份與恢復(fù)的需求要求，則要做相應(yīng)的設(shè)計(jì)描述。 對(duì)數(shù)據(jù)備份與恢復(fù)的設(shè)計(jì)，主要說(shuō)明在適當(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ù)庫(kù)中存儲(chǔ)的數(shù)據(jù)大部分是非常重要的商業(yè)交易數(shù)據(jù)，它要求高度的安全性和強(qiáng)健的完整性，所以，必須制定功能完善的數(shù)據(jù)備份策略，充分 保證數(shù)據(jù)庫(kù)系統(tǒng)的安全和完整。為此制定以下安全備份措施： 所有交易數(shù)據(jù)庫(kù)，全部對(duì)應(yīng)建立歷史備份數(shù)據(jù)庫(kù)，定期將當(dāng)前數(shù)據(jù)庫(kù)中的數(shù)據(jù)追加到歷史數(shù)據(jù)庫(kù)中。 對(duì)歷史數(shù)據(jù)庫(kù)中的數(shù)據(jù)，定期備份。一般當(dāng)前數(shù)據(jù)，每月一次自動(dòng)復(fù)制到歷史數(shù)據(jù)庫(kù)中；歷史數(shù)據(jù)保留半年后，使用光盤(pán)刻錄設(shè)備，進(jìn)行 2 份以上備份存檔，然后可清除歷史數(shù)據(jù)庫(kù)和當(dāng)前數(shù)據(jù)庫(kù)中的這部份數(shù)據(jù)，以提高系統(tǒng)運(yùn)行效率，釋放部分硬件資源。 主數(shù)據(jù)庫(kù)服務(wù)器使用磁帶備份系統(tǒng)，對(duì)數(shù)據(jù)庫(kù)中的實(shí)時(shí)數(shù)據(jù)作更新備份和增量備份（不包括歷史庫(kù)）。 1. 數(shù)據(jù)庫(kù)日備份：系統(tǒng)每日自動(dòng)將更新操作后的數(shù)據(jù)備份 到磁帶機(jī)上。 2. 數(shù)據(jù)庫(kù)周備份：每周一次，系統(tǒng)自動(dòng)將所有數(shù)據(jù)庫(kù)備份到磁帶機(jī)上。 3. 數(shù)據(jù)庫(kù)月備份：每月一次，系統(tǒng)自動(dòng)備份所有數(shù)據(jù)庫(kù)到磁帶機(jī)上。 主數(shù)據(jù)庫(kù)服務(wù)器使用跟蹤帶，對(duì)系統(tǒng)操作進(jìn)行跟蹤記錄。 數(shù)據(jù)恢復(fù) 數(shù)據(jù)的恢復(fù)措施主要與數(shù)據(jù)備份相對(duì)應(yīng)： 如果當(dāng)前數(shù)據(jù)庫(kù)因故遭到破壞，不能保證其完整性時(shí)，應(yīng)進(jìn)行恢復(fù)。步驟如下： 1. 先將歷史庫(kù)中的數(shù)據(jù)追加到當(dāng)前庫(kù)中。 2. 將磁帶上的數(shù)據(jù)按月備份、周備份、日備份的順序，依次恢復(fù)到當(dāng)前數(shù)據(jù)統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 15頁(yè) 庫(kù)中。 3. 按照跟蹤帶上的操作順序，將當(dāng)天的數(shù)據(jù)進(jìn)行恢復(fù)。 可根據(jù)具體情況選擇其中的若干步執(zhí)行。 如需查詢歷 史數(shù)據(jù)，可將光盤(pán)中部分或全部歷史數(shù)據(jù)，重新導(dǎo)入數(shù)據(jù)庫(kù)中。 10. 系統(tǒng)運(yùn)行設(shè)計(jì) 為可選項(xiàng)，當(dāng)系統(tǒng)足夠大被拆分成若干子系統(tǒng)，如果不專(zhuān)門(mén)介紹系統(tǒng)運(yùn)行時(shí)各子系統(tǒng)之間的運(yùn)行機(jī)制和控制關(guān)系，則開(kāi)發(fā)人員無(wú)法理解本概要設(shè)計(jì)說(shuō)明書(shū)而導(dǎo)致無(wú)法實(shí)現(xiàn)系統(tǒng)功能時(shí)，才有必要進(jìn)行相關(guān)運(yùn)行設(shè)計(jì)的描述。 運(yùn)行設(shè)計(jì)，主要用來(lái)說(shuō)明運(yùn)行模塊的組合，進(jìn)行軟件系統(tǒng)的構(gòu)造設(shè)計(jì)，確定系統(tǒng)的運(yùn)行控制方法及資源分配情況 行模塊組合 說(shuō)明對(duì)系統(tǒng)施加不同的外界運(yùn)行控制時(shí)所引起的各種不同的運(yùn)行模塊組合，說(shuō)明每種運(yùn)行所歷經(jīng)的內(nèi)部模塊和支持軟件，建議畫(huà)出系統(tǒng)運(yùn)行機(jī)制結(jié)構(gòu)圖 來(lái)表示，再附上簡(jiǎn)要的文字說(shuō)明，以描述清楚各個(gè)運(yùn)行模塊（包括各種運(yùn)行的進(jìn)程），分別如何運(yùn)行在各自指定的硬件上（必要時(shí)要說(shuō)明相關(guān)的硬件配置及其在運(yùn)行環(huán)境下所起的作用） 行控制 描述清楚各個(gè)運(yùn)行模塊進(jìn)行運(yùn)行控制的方式、方法和操作步驟，以及每種運(yùn)行模塊組合將各自占用的各種資源情況，以及對(duì)時(shí)間響應(yīng)的要求，可以分別從以下幾方面進(jìn)行描述： 多機(jī)管理，一臺(tái)服務(wù)器應(yīng)允許多臺(tái)客戶端機(jī)器加入應(yīng)用系統(tǒng)，則要描述清楚服務(wù)器是如何進(jìn)行管理多臺(tái)機(jī)器的。 合法性檢查，當(dāng)客戶端需要訪問(wèn)后臺(tái)數(shù)據(jù)庫(kù)的業(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)都會(huì)要求每一個(gè)用戶發(fā)出某個(gè)服務(wù)請(qǐng)求后，必須首先輸入自己的用戶名和密碼 請(qǐng)求響應(yīng)，有關(guān)服務(wù)器對(duì)用戶的各種請(qǐng)求的響應(yīng)，采用多線程的并發(fā)處理還是單線程的串行順序處理等方式的實(shí)現(xiàn)情況，以及對(duì)事務(wù)處理的時(shí)間響應(yīng)要求等 控制界面，關(guān)于用戶監(jiān)控系統(tǒng)（如：國(guó)泰君安實(shí)時(shí)監(jiān)控系統(tǒng)）的監(jiān)控屏幕上應(yīng)該顯示各種業(yè)務(wù)處理信息，出現(xiàn)異常時(shí)要求要實(shí)時(shí)報(bào)警或做相應(yīng)妥善的處理。 通訊控制，描述清楚系統(tǒng)所采納的通訊 平臺(tái)的有關(guān)說(shuō)明，包括前臺(tái)和后臺(tái)之統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 16頁(yè) 間的通訊、網(wǎng)關(guān)之間的數(shù)據(jù)轉(zhuǎn)換處理，以及通訊時(shí)所采用的通訊協(xié)議等內(nèi)容 核心業(yè)務(wù)處理，說(shuō)明對(duì)客戶的許多關(guān)鍵或主要業(yè)務(wù)的系統(tǒng)實(shí)現(xiàn)，在整個(gè)運(yùn)行機(jī)制中是如何進(jìn)行控制的 11. 系統(tǒng)出錯(cuò)處理設(shè)計(jì) 為可選項(xiàng)，如果不專(zhuān)門(mén)對(duì)系統(tǒng)出錯(cuò)信息進(jìn)行設(shè)計(jì)描述，將導(dǎo)致開(kāi)發(fā)人員無(wú)法理解本概要設(shè)計(jì)的有關(guān)出錯(cuò)信息的處理說(shuō)明，無(wú)法實(shí)現(xiàn)有關(guān)出錯(cuò)處理功能時(shí)，才需要描述本章節(jié)的內(nèi)容 錯(cuò)處理信息 羅列本軟件系統(tǒng)可能的出錯(cuò)或故障情況出現(xiàn)的各種出錯(cuò)處理信息，包括系統(tǒng)出錯(cuò)信息提示的形式（包括出錯(cuò)對(duì)話框的設(shè)計(jì)）、含義及處理方法等。 在 操作出錯(cuò)或數(shù)據(jù)出錯(cuò)等情況下，系統(tǒng)顯示或記錄的有關(guān)出錯(cuò)代碼信息，要求要符合相關(guān)的系統(tǒng)出錯(cuò)處理設(shè)計(jì)規(guī)范（如果規(guī)范存在的話） 出錯(cuò)的分類(lèi)可以參考以下： 通訊線路錯(cuò)誤 系統(tǒng)環(huán)境錯(cuò)誤 應(yīng)用設(shè)計(jì)錯(cuò)誤 錯(cuò)處理對(duì)策 說(shuō)明故障出現(xiàn)或系統(tǒng)出錯(cuò)后可能采取的變通補(bǔ)救辦法，主要包括：設(shè)置后備技術(shù)、性能降級(jí)（即降效技術(shù)）、恢復(fù)及再啟動(dòng)等等。 設(shè)置后備技術(shù)，體現(xiàn)在：當(dāng)原始系統(tǒng)數(shù)據(jù)萬(wàn)一丟失時(shí)則啟用的副本的建立或啟動(dòng)的技術(shù)，采用磁帶備份等 降效技術(shù)，也是一種后備技術(shù)，體現(xiàn)在：使用另一種效率稍低的系統(tǒng)或方法求得所需結(jié)果的某些部分， 如手工操作。 下述為對(duì)于系統(tǒng)環(huán)境出錯(cuò)處理對(duì)策參考： 統(tǒng) 要設(shè)計(jì)說(shuō)明書(shū) 共 19 頁(yè) 第 17頁(yè) 系統(tǒng)故障根據(jù)系統(tǒng)類(lèi)型可分為四類(lèi)：系統(tǒng)軟件故障、應(yīng)用軟件故障、硬件系統(tǒng)故障、網(wǎng)絡(luò)系統(tǒng)故障。系統(tǒng)維護(hù)工作的進(jìn)行，應(yīng)建立在對(duì)系統(tǒng)正常按章操作的基礎(chǔ)上，把人為損壞的因素降到最低。因此，良好和規(guī)范的操作習(xí)慣是保證系統(tǒng)穩(wěn)定運(yùn)行的重要保障。 系統(tǒng)類(lèi)型 故障類(lèi)型 維護(hù)措施 系統(tǒng)軟件 統(tǒng)故障 設(shè)置專(zhuān)職系統(tǒng)管理員 統(tǒng)故障類(lèi)型較多，具體故障對(duì)應(yīng)具體的處理辦法，不能一一列舉。但在系統(tǒng)安裝設(shè)置完成后，應(yīng)及時(shí)備份主要系統(tǒng)文件，編制一些系統(tǒng)維護(hù)管理的 序，盡可能方便地提供管理信息，幫助系統(tǒng)管理員進(jìn)行系統(tǒng)維護(hù)工作 T 系統(tǒng)故障 設(shè)置專(zhuān)職系統(tǒng)管理員，其他用戶嚴(yán)格授權(quán)。系統(tǒng)安裝病毒實(shí)時(shí)監(jiān)測(cè)掃描軟件，定期更新病毒特征代碼文件 統(tǒng)故障類(lèi)型也較多，要求系統(tǒng)管理員具備專(zhuān)業(yè)的系統(tǒng)管理知識(shí)和經(jīng)驗(yàn)，針對(duì)具體情況采用不同的維護(hù)策略 統(tǒng)故障 一般情況下，硬盤(pán)分成二個(gè)分區(qū)，系統(tǒng)放在 C 盤(pán)，數(shù)據(jù)存放在D 盤(pán)安裝病毒實(shí)時(shí)監(jiān)測(cè)掃描軟件，定期更新病毒特征代碼文件其它故障由系統(tǒng)管理員根據(jù)具體情況處理 應(yīng)用軟件 不能實(shí)現(xiàn)設(shè)計(jì)功能 檢查操作流程及先后順序是否正確檢查輸入數(shù)據(jù)的合法性和有效性仍有問(wèn)題，與開(kāi)發(fā)商聯(lián)系 執(zhí)行出現(xiàn)錯(cuò)誤及提示 根據(jù)提示重新操作如屬系統(tǒng)錯(cuò)誤，與開(kāi)發(fā)商聯(lián)系 硬件系統(tǒng) 主服務(wù)器硬盤(pán)發(fā)生故障，讀寫(xiě)出錯(cuò) 磁盤(pán)陣列或冗余方式下直接更