系統(tǒng)概要設(shè)計說明書編寫標(biāo)準(zhǔn)全套

系統(tǒng)概要設(shè)計說明書編寫標(biāo)準(zhǔn)1前言1.1文檔目的文檔編寫目的是為了闡述XXX系統(tǒng)的概要設(shè)計。概要設(shè)計說明書是為了說明整個XXX系統(tǒng)的體系架構(gòu)，以及需求用例的各個功能點(diǎn)在架構(gòu)中的體現(xiàn)，為系統(tǒng)的詳細(xì)設(shè)計人員進(jìn)行詳細(xì)設(shè)計時的輸入?yún)⒖嘉臋n。本說明書的預(yù)期讀者為系統(tǒng)設(shè)計人員、系統(tǒng)開發(fā)人員和項(xiàng)目評審人員。1.2背景XXX系統(tǒng)是[項(xiàng)目背景]1.3文檔范圍1、產(chǎn)品范圍：根據(jù)《需求規(guī)格說明書》，該文檔闡述軟件產(chǎn)品的功能2、涉及到的干系人有：公司高層、客戶、項(xiàng)目經(jīng)理、質(zhì)量小組、開發(fā)小組。1.4讀者對象項(xiàng)目經(jīng)理、質(zhì)量保證人員：據(jù)此來進(jìn)入項(xiàng)目策劃過程測試人員：據(jù)此進(jìn)入測試過程。需求管理員、配置管理員：可以識別配置項(xiàng)制定相關(guān)的活動計劃用戶IT主管：清楚與確認(rèn)項(xiàng)目需求。開發(fā)人員，包括設(shè)計人員、編碼人員：明確任務(wù)與需求，清楚項(xiàng)目開發(fā)流程。1.5參考文檔《需求規(guī)格說明書》1.6術(shù)語與縮寫解釋術(shù)語或縮略語解釋2總體設(shè)計2.1系統(tǒng)描述2.1.1系統(tǒng)概述XXX系統(tǒng)，采用XXX架構(gòu)開發(fā)出的XXX平臺。2.1.2運(yùn)行環(huán)境對本平臺所賴于運(yùn)行的硬件、軟件環(huán)境的描述。1.服務(wù)端操作系統(tǒng)：WindowsServer2003SP2及以上；2.服務(wù)端運(yùn)行環(huán)境：JDK1.7及以上；3.數(shù)據(jù)庫支持：Oracle10g企業(yè)版；4.協(xié)議支持：TCP/IP、HTTP、HTTPS、SMTP、POP3等；5.硬件支持：服務(wù)器CPU2.0GHz以上、內(nèi)存2G以上、需要300G以上的空閑磁盤空間；6.網(wǎng)絡(luò)環(huán)境：有固定公網(wǎng)IP，網(wǎng)絡(luò)暢通，可以遠(yuǎn)程訪問(遠(yuǎn)程桌面連接或者借助輔助工具)；7.客戶端要求：IE10以上；2.1.3數(shù)據(jù)管理要求2.1.4故障處理要求（1）產(chǎn)品支撐環(huán)境運(yùn)行錯誤，包括以下幾個方面：數(shù)據(jù)庫運(yùn)行錯誤：系統(tǒng)無法使用，將提供錯誤提示頁面，并記錄日志。系統(tǒng)配置參數(shù)錯誤：系統(tǒng)提供錯誤提示頁面，要求管理員修改相關(guān)配置參數(shù)。配置參數(shù)的修改方法應(yīng)參考相關(guān)為管理員提供的手冊。系統(tǒng)參數(shù)初始化錯誤：提供系統(tǒng)初始化功能，用于成批完成系統(tǒng)初始化。在初始化過程中，對于嚴(yán)重影響平臺運(yùn)行的錯誤，提供錯誤提示頁面。對于普通錯誤，記錄日志。應(yīng)用程序錯誤：由應(yīng)用程序提供錯誤提示頁面，相關(guān)錯誤應(yīng)記錄日志。2.1.5其他要求2先進(jìn)性：采用先進(jìn)成熟的技術(shù)，確保系統(tǒng)的先進(jìn)性、經(jīng)濟(jì)性和實(shí)用性。2安全可靠：提供的應(yīng)用框架及平臺本身提供應(yīng)用安全保證，并可以和第三方安全手段，如認(rèn)證、加密、電子簽名等進(jìn)行集成。必須保證數(shù)據(jù)的安全性和保密性。對于基于平臺開發(fā)的應(yīng)用系統(tǒng)，只允許有權(quán)限的人員進(jìn)行操作和瀏覽信息。必須有安全的手段來進(jìn)行權(quán)限控制。2開放互連：系統(tǒng)應(yīng)對各類業(yè)務(wù)系統(tǒng)、數(shù)據(jù)庫系統(tǒng)、WEB信息等具有通用的或可定制的接口策略和連接方法。2規(guī)范性：開發(fā)過程控制、開發(fā)技術(shù)、系統(tǒng)編碼、文檔應(yīng)規(guī)范化，并遵循相應(yīng)的國內(nèi)外標(biāo)準(zhǔn)。開發(fā)結(jié)束，需要提供必要的文檔資料。2可靠性：保證系統(tǒng)的可靠運(yùn)行和在升級過程中的方便快捷。2可擴(kuò)充性：系統(tǒng)應(yīng)當(dāng)可以根據(jù)需求的變化，方便地進(jìn)行功能的調(diào)整、增減，模塊的升級和系統(tǒng)架構(gòu)的逐步完善。2界面友好、操作方便：操作界面要直觀、簡單、貼近實(shí)際，操作過程應(yīng)當(dāng)盡量簡化，符合實(shí)際過程。身份認(rèn)證過程即要保證安全，也要盡量簡化認(rèn)證過程。2可維護(hù)性：系統(tǒng)維護(hù)應(yīng)當(dāng)簡單。2.2總體設(shè)計說明2.2.1基本設(shè)計概述從《需求規(guī)格說明書》出發(fā)，根據(jù)需求分析階段確定的功能設(shè)計軟件系統(tǒng)的整體結(jié)構(gòu)、劃分功能模塊、確定每個模塊的實(shí)現(xiàn)算法以及編寫具體的代碼，形成軟件的具體設(shè)計方案。2.2.2設(shè)計思想本概要設(shè)計主要由結(jié)構(gòu)設(shè)計、接口設(shè)計、全局?jǐn)?shù)據(jù)結(jié)構(gòu)設(shè)計及其他方面設(shè)計組成。需遵循軟抽象、模塊化、信息隱蔽及模塊獨(dú)立性等特征。模塊獨(dú)立性從兩個方面度量：(1)內(nèi)聚性：偶然內(nèi)聚、邏輯內(nèi)聚、時間內(nèi)聚、過程內(nèi)聚、通信內(nèi)聚、順序內(nèi)聚、功能內(nèi)聚。(2)耦合性：內(nèi)容耦合、公共耦合、外部耦合、控制耦合、標(biāo)記耦合、數(shù)據(jù)耦合、非直接耦合2.2.3系統(tǒng)總體結(jié)構(gòu)系統(tǒng)總體結(jié)構(gòu)2.2.4處理流程【描述系統(tǒng)主要功能模塊的處理流程】3接口設(shè)計3.1外部接口【描述系統(tǒng)與外部第三方系統(tǒng)之間的接口】3.2內(nèi)部接口【描述系統(tǒng)內(nèi)部各子系統(tǒng)之間的接口】4系統(tǒng)結(jié)構(gòu)設(shè)計4.1模塊14.1.1功能A1.界面原型2.實(shí)現(xiàn)功能4.1.2功能B1.界面原型2.實(shí)現(xiàn)功能4.2模塊24.2.1功能C1.界面原型2.功能說明4.2.2功能D1.界面原型2.功能說明5系統(tǒng)數(shù)據(jù)結(jié)構(gòu)5.1邏輯結(jié)構(gòu)設(shè)計要點(diǎn)XXX系統(tǒng)采用ORACLE數(shù)據(jù)庫。該數(shù)據(jù)庫基都是關(guān)系數(shù)據(jù)庫首先需要將E-R圖轉(zhuǎn)換為關(guān)系模型，然后根據(jù)具體DBMS的特點(diǎn)和限制轉(zhuǎn)換為特定的DBMS支持下的數(shù)據(jù)模型，最后進(jìn)行優(yōu)化。1、E-R圖向關(guān)系模型的轉(zhuǎn)換規(guī)則：一個實(shí)體型轉(zhuǎn)換為一個關(guān)系模式；一個1:1聯(lián)系可以轉(zhuǎn)換為一個獨(dú)立的關(guān)系模式，也可以與任意一端對應(yīng)的關(guān)系模式合并；一個1:n聯(lián)系可以轉(zhuǎn)換為一個獨(dú)立的關(guān)系模式，也可以與n端對應(yīng)的關(guān)系模式合并；一個m:n聯(lián)系可以轉(zhuǎn)換為一個獨(dú)立的關(guān)系模式；一個多元聯(lián)系可以轉(zhuǎn)換為一個獨(dú)立的關(guān)系模式；具有相同碼的關(guān)系模式可以合并；有些1：n的聯(lián)系，將屬性合并到n端后，該屬性也作為主碼的一部分2、數(shù)據(jù)抽象分類3、數(shù)據(jù)模型優(yōu)化：確定數(shù)據(jù)依賴，對數(shù)據(jù)依賴進(jìn)行極小化處理，消除冗余聯(lián)系。確定范式級別，根據(jù)應(yīng)用環(huán)境，對某些模式進(jìn)行合并或分解4、設(shè)計用戶子模式：考慮使用方便性和效率問題，主要借助視圖手段實(shí)現(xiàn)，包括：建立視圖，使用更符合用戶習(xí)慣的別名；對不同級別的用戶定義不同的視圖，以保證系統(tǒng)的安全性；對復(fù)雜的查詢操作，可以定義視圖，簡化用戶對系統(tǒng)的使用。5.2數(shù)據(jù)結(jié)構(gòu)與模塊的關(guān)系物理數(shù)據(jù)結(jié)構(gòu)設(shè)計主要是設(shè)計數(shù)據(jù)在模塊中的表示形式。數(shù)據(jù)在模塊中都是以結(jié)構(gòu)的方式表示。系統(tǒng)操作對數(shù)據(jù)庫數(shù)據(jù)結(jié)構(gòu)，也就是數(shù)據(jù)表進(jìn)行查詢和修改，在操作過程中都需要對數(shù)據(jù)庫中的所有表，進(jìn)行聯(lián)合查詢、修改。主要用于各模塊之間函數(shù)的信息傳遞。接口傳遞的信息將是以數(shù)據(jù)結(jié)構(gòu)封裝了的數(shù)據(jù)，以參數(shù)傳遞或返回值的形式在各模塊間傳輸。出錯信息將送入顯示模塊中。6運(yùn)行設(shè)計6.1運(yùn)行模塊的組合程序在有輸入時啟動接收數(shù)據(jù)模塊，通過各模塊之間的調(diào)用，讀入并對輸入進(jìn)行格式化。在接收數(shù)據(jù)模塊得到充分的數(shù)據(jù)時，將調(diào)用網(wǎng)絡(luò)傳輸模塊，將數(shù)據(jù)通過網(wǎng)絡(luò)送到服務(wù)器，并等待接收服務(wù)器返回的信息。接收到返回信息后隨即調(diào)用數(shù)據(jù)輸出模塊，對信息進(jìn)行處理，產(chǎn)生相應(yīng)的輸出。服務(wù)器程序的接收網(wǎng)絡(luò)數(shù)據(jù)模塊必須始終處于活動狀態(tài)。接收到數(shù)據(jù)后，調(diào)用數(shù)據(jù)處理/查詢模塊對數(shù)據(jù)庫進(jìn)行訪問，完成后調(diào)用程序模塊，將信息返回客戶端6.2運(yùn)行控制運(yùn)行控制將嚴(yán)格按照各模塊間函數(shù)調(diào)用關(guān)系來實(shí)現(xiàn)。在各事務(wù)中心模塊中，需對運(yùn)行控制進(jìn)行正確的判斷，選擇正確的運(yùn)行控制路徑。6.3運(yùn)行時間在產(chǎn)品的需求分析中，對運(yùn)行時間的要求為必須對作出的操作有較快的反應(yīng)。網(wǎng)絡(luò)硬件對運(yùn)行時間有最大的影響，當(dāng)網(wǎng)絡(luò)負(fù)載量大時，對操作反應(yīng)將受到很大的影響。所以將采用高速ATM網(wǎng)絡(luò)，實(shí)現(xiàn)客戶機(jī)與服務(wù)器之間的連接，以減少網(wǎng)絡(luò)傳輸上的開銷。其次是服務(wù)器的性能，這將影響對數(shù)據(jù)庫訪問時間即操作時間的長短，影響加大客戶機(jī)操作的等待時間，所以必須使用高性能的服務(wù)器，建議使用PentiumIII處理器。硬件對本系統(tǒng)的速度影響將會大于軟件的影響。7系統(tǒng)錯誤處理機(jī)制出錯類型處理方法輸入信息，或無法滿足要求時產(chǎn)生的錯誤須在操作成功判斷及輸入數(shù)據(jù)驗(yàn)證模塊由數(shù)據(jù)進(jìn)行數(shù)據(jù)分析，判斷錯誤類型，再生成相應(yīng)的錯誤提示語句，送到輸出模塊中由于其它問題，如網(wǎng)絡(luò)傳輸超時等，產(chǎn)生的問題可在出錯的相應(yīng)模塊中輸出簡單的出錯語句，并將程序重置；返回輸入階段。服