軟件開發(fā)規(guī)范之總體設計方案模板.doc

精品文檔一引言1.1編寫目的本文檔作為*與XXXXXXXXXX公司之間就*建立XXXX司（局或單位）XXXXXXXXXX系統(tǒng)需求理解達成一致共識的基礎文件，作為雙方界定項目范圍、簽定合同的主要基礎，也作為本項目驗收的主要依據。同時，本文檔也作為*XXX后繼工作開展的基礎，供雙方項目主管負責人、項目經理、技術開發(fā)人員、測試人員等理解需求之用。1.2適用范圍本文檔適用于所有與本項目有關的軟件開發(fā)階段及其相關人員，其中：*方面的項目負責人、公司方項目經理、技術開發(fā)人員（包括分析人員、設計人員、程序人員）、測試人員應重點閱讀本文檔各部分，其他人員可選擇性閱讀本文檔。1.3文檔概述本文檔主要描述了XXXXXXXXXX系統(tǒng)項目的軟件總體設計思路。本文檔首先從業(yè)務背景、系統(tǒng)功能、運行環(huán)境等方面概要描述系統(tǒng)，其次從設計原則、功能設計、數據結構設計等方面描述系統(tǒng)的總體設計情況，然后進一步詳細描述系統(tǒng)技術實現策略、項目實施以及待確定的問題。1.4參考資料列出本文的參考文件清單，包括出版單位、作者、版本、日期等信息。示范：僅供參考，不具備任何實質性的內容。XXX總體需求書 （XXX單位XXX提供）XXX需求調研報告 作者：XXX設計模式 XXXXXX出版社 UML用戶指南 XXXXXXX出版社 1.5術語、定義和縮寫列出本文檔所涉及的專業(yè)術語、縮寫詞及相關定義。定義所有必要的術語，以便讀者可以正確地解釋軟件需求規(guī)格說明，包括詞頭和縮寫。你可能希望為整個公司創(chuàng)建一張跨越多項項目的詞匯表，并且只包括特定于單一項目的軟件需求規(guī)格說明中的術語。示范：僅供參考，不具備任何實質性的內容。1) OLTP：On-line Transaction Processing，聯機事務處理。2) OLAP：On-Line Analytical Processing，聯機分析處理；是使分析人員、管理人員或執(zhí)行人員能夠從多角度對信息進行快速、一致、交互地存取,從而獲得對數據的更深入了解的一類軟件技術。二總體概述2.1現有系統(tǒng)描述簡要描述客戶現有系統(tǒng)的功能、性能以及其他方面，若客戶沒有系統(tǒng)，則可裁減。另外，可描述客戶現有系統(tǒng)的應用狀況以及系統(tǒng)規(guī)模、人員使用狀況。描述客戶對象的應用環(huán)境平臺，如軟件環(huán)境、硬件環(huán)境、網絡環(huán)境、通訊狀況以及人員計算機使用水平等。示范：僅供參考，不具備任何實質性的內容。針對金融快報工作，*以前曾開發(fā)過一個C/S結構的系統(tǒng)，后臺數據庫為SQL Server，開發(fā)工具是VB6.0。該系統(tǒng)主要完成以下工作：1. 根據人行各業(yè)務司局每日上報的數據傳真，將數據補錄到系統(tǒng)中。2. 根據上報的數據制作金融快報文檔。3. 將金融快報的數據轉發(fā)到人行時間序列數據庫中。金融快報系統(tǒng)的工作流程如下： 2.2存在問題通過上述現狀描述，分析現有組織結構、現有系統(tǒng)等方面存在的問題。示范：僅供參考，不具備任何實質性的內容。該系統(tǒng)初步滿足了金融快報工作的要求，但是，當前由于各級領導對快報內容的要求不斷變化，系統(tǒng)無法通過參數配置來滿足日益變化的內容要求。同時，由于系統(tǒng)的C/S架構特點，系統(tǒng)無法實現各業(yè)務司局自行報送統(tǒng)計數據的要求，因此需要對原系統(tǒng)進行改進以滿足業(yè)務的需要。2.3系統(tǒng)建設目標簡要說明本項目或系統(tǒng)的總體目標，即建成什么樣的應用系統(tǒng)。示范：僅供參考，不具備任何實質性的內容。新的系統(tǒng)基于B/S結構，更加適合金融快報“快”的特點，打破了原系統(tǒng)過多依賴外部介質的陳規(guī)，以簡便、易用為設計思想，以所見即所得為設計指導，以*內聯網為傳媒，真正實現了業(yè)務人員自主報送，管理人員專注管理工作。2.4需求概述可以用圖表的形式給出總體業(yè)務流程圖，并簡要描述總體業(yè)務流程，業(yè)務范圍和要求。以圖表的形式給出隸屬于總體業(yè)務流程圖的子系統(tǒng)業(yè)務流程圖并描述子系統(tǒng)業(yè)務流程。簡要描述（子）業(yè)務規(guī)則，如智能化的計算規(guī)則，數據抽取、加載規(guī)則等業(yè)務規(guī)則。簡要描述用戶層的需求，可用圖表的形式給出。若不需要在此表述，可裁剪。簡要描述功能性和非功能性需求，可以圖表的方式給出。示范：僅供參考，不具備任何實質性的內容。為了能使金融快報處理工作更方便，適合報表樣式靈活變動的特點，*調查統(tǒng)計司提出：新的金融快報系統(tǒng)應該結合數據交換技術架構體系，由各司局人員自由報數；在金融快報系統(tǒng)內生成金融快報WORD文檔、EXCEL文件和生成時間序列數據文件；采用靈活指標模式，方便添加指標；采用靈活的模板定制模式，方便更換報送文件模板。2.5新系統(tǒng)功能可以用圖表的形式列出新系統(tǒng)具有哪些功能，特別是特色功能，并簡要描述新系統(tǒng)的功能。示范：僅供參考，不具備任何實質性的內容。這套金融快報信息系統(tǒng)主要包含以下幾個方面的功能： 1. 數據報送，幫助各業(yè)務司局方便的將數據錄入到系統(tǒng)中。2. 數據管理，幫助調查統(tǒng)計司綜合處對報送的數據進行審核。3. 快報輸出，根據收集到的數據進行整理加工，并將數據的結果按照國辦與中辦的要求進行輸出。4. 數據轉發(fā)，收集到的數據按照接口的要求轉送時間序列數據庫。5. 系統(tǒng)管理，對系統(tǒng)的用戶、權限進行管理。6. 配置管理，對數據報送的格式、金融快報的模版以及轉發(fā)時間序列數據庫的要求進行配置管理。三系統(tǒng)設計3.1設計原則簡要描述本業(yè)務系統(tǒng)總體設計原則和設計依據。3.1.1總體設計路線描述本業(yè)務系統(tǒng)總體設計路線。示范：僅供參考，不具備任何實質性的內容。金融快報系統(tǒng)參考現有系統(tǒng)設計方案，采用B/S結構進行系統(tǒng)設計，提供與數據交換平臺進行數據傳輸的軟件接口，提供靈活的指標，模板定制方案，極大地提高金融快報處理工作效率。3.1.2總體技術架構以圖表的形式勾畫出新系統(tǒng)的體系結構圖，應包括與外部應用系統(tǒng)的連接，硬件設備的連接，網絡系統(tǒng)的連接等。示范：僅供參考，不具備任何實質性的內容。3.1.3總體功能架構可以用圖表的形式列出那些與應用程序自動進行數據處理的過程相對應、需要通過用戶交互來完成的處理過程。對于每種角色描述，應指出這種角色能夠勝任哪些任務，有多少用戶可能具備這種角色，以及（在可能情況下）這種角色能夠在工作流批準或狀態(tài)改變中充當哪些處理過程?？梢杂脠D表的形式列出本應用系統(tǒng)有哪些程序模塊，每個模塊的功能是什么。示范：僅供參考，不具備任何實質性的內容。金融快報系統(tǒng)的源數據由各司局人員在線報送得到，經過金融快報管理員處理后生成要報送的數據文件進行數據報送，整個金融快報系統(tǒng)工作流程如下：首先，各司局人員通過數據交換平臺進行業(yè)務數據報送，系統(tǒng)接收數據后自動對當天數據進行加鎖處理，如果業(yè)務人員需求重報數據，則需要通知系統(tǒng)管理員進行數據解鎖。數據上報完畢后，管理人員對數據進行數據查看和數據修改，可以對要生成的文件添加注釋等。處理完畢后，可以生成、下載快報文件和時間序列文件。系統(tǒng)功能圖如下： 3.1.4系統(tǒng)功能部署把系統(tǒng)功能的部署情況逐一表述清楚。示范：僅供參考，不具備任何實質性的內容。金融快報所有模塊均部署于服務器端，功能分別由金融快報管理信息系統(tǒng)模塊和通用數據交換平臺中的數據采集模塊共同實現。其中通用數據交換平臺實現單點登陸、權限驗證、數據上報功能，而金融快報管理信息系統(tǒng)實現快報的系統(tǒng)管理、數據管理和文件生成等功能。3.1.5系統(tǒng)特點把系統(tǒng)的新特點情況逐一表述清楚。示范：僅供參考，不具備任何實質性的內容。金融快報系統(tǒng)具有以下特點： 良好的可擴充性和通用性：靈活多樣的數據采集方式與報表定義模式，方便用戶采集各種數據。 貼心的模板定制體系：采用大眾熟悉的MS EXCEL所見即所得報表定義,無需特殊培訓，可以使業(yè)務人員輕松實現報表定義。3.2系統(tǒng)用戶列出本系統(tǒng)全部用戶的整體信息。示范：僅供參考，不具備任何實質性的內容。3.2.1普通用戶描述本系統(tǒng)的普通用戶的整體信息。示范：僅供參考，不具備任何實質性的內容。3.2.2登錄用戶描述本系統(tǒng)的登錄用戶的整體信息。示范：僅供參考，不具備任何實質性的內容。3.2.3訪客描述本系統(tǒng)的訪問用戶的整體信息。示范：僅供參考，不具備任何實質性的內容。3.2.4部門管理員描述本系統(tǒng)的部門級別管理員的整體信息。示范：僅供參考，不具備任何實質性的內容。3.2.5系統(tǒng)管理員描述本系統(tǒng)的系統(tǒng)管理員的整體信息。示范：僅供參考，不具備任何實質性的內容。3.2.6信息子系統(tǒng)列出本系統(tǒng)所含蓋的全部子系統(tǒng)的參考清單等信息。示范：僅供參考，不具備任何實質性的內容。3.3系統(tǒng)功能設計示例列出本系統(tǒng)的功能參考文件清單。示范：僅供參考，不具備任何實質性的內容。3.3.1快報版本管理示例列出本模塊實現的基本功能點等信息。示范：僅供參考，不具備任何實質性的內容。管理生成快報文件的版本。3.3.2快報文件結構管理示例列出本模塊實現的基本功能點等信息。示范：僅供參考，不具備任何實質性的內容。管理快報文件的機構，內容和順序。3.3.3文件內容管理示例列出本模塊實現的基本功能點等信息。示范：僅供參考，不具備任何實質性的內容。管理用于生成快報文件的文件內容。3.3.4指標信息管理示例列出本模塊實現的基本功能點等信息。示范：僅供參考，不具備任何實質性的內容。定義文件中所采用的指標信息。3.3.5快報生成模板管理示例列出本模塊實現的基本功能點等信息。示范：僅供參考，不具備任何實質性的內容。編制定義金融快報中用來生成快報，轉換數據查看，轉換數據修改的模板文件。3.3.6數據采集模板管理示例列出本模塊實現的基本功能點等信息。示范：僅供參考，不具備任何實質性的內容。編制定義用來在線報數，原始數據查看，原始數據修改的模板文件。3.3.7報送機構信息管理示例列出本模塊實現的基本功能點等信息。示范：僅供參考，不具備任何實質性的內容。登記、維護要進行報送的司局信息。3.3.8報送規(guī)則維護示例列出本模塊實現的基本功能點等信息。示范：僅供參考，不具備任何實質性的內容。管理各司局要報送的數據屬性。3.3.9系統(tǒng)常量信息維護示例列出本模塊實現的基本功能點等信息。示范：僅供參考，不具備任何實質性的內容。管理系統(tǒng)中的常量信息，如文件存放路徑等。3.3.10快報管理示例列出本模塊實現的基本功能點等信息。示范：僅供參考，不具備任何實質性的內容。通過快報管理，用戶可根據模版選擇生成金融快報，并可對歷史各期快報進行分類檢索。3.3.11數據查詢示例列出本模塊實現的基本功能點等信息。示范：僅供參考，不具備任何實質性的內容。金融快報管理員通過該功能查詢各監(jiān)管司局的各期報送數據。3.4數據結構設計以圖表的形式列出本應用系統(tǒng)的數據結構并予以說明。示范：僅供參考，不具備任何實質性的內容。3.5接口設計1）內部接口設計以圖表的形式列出本應用系統(tǒng)內部的數據接口、通信接口、應用接口設計，并予以說明。2）外部接口設計以圖表的形式列出本應用系統(tǒng)與外部應用系統(tǒng)的接口設計，包括數據交換、網絡通信等外部接口設計，并予以說明。3）與其他網絡系統(tǒng)的接口設計以圖表的形式列出本應用系統(tǒng)與其他網絡系統(tǒng)的接口設計，包括網絡協議，通信接口、數據傳輸接口等，并予以描述。示范：僅供參考，不具備任何實質性的內容。3.6系統(tǒng)性能及安全設計詳細描述對于新系統(tǒng)的性能、安全性以及其他非功能性等方面是如何考慮設計的，如系統(tǒng)響應速度，數據處理速度、網絡傳輸速度、數據加密、權限設計等方面。示范：僅供參考，不具備任何實質性的內容。四實現策略4.1技術策略從技術角度詳細說明如何來實現新應用系統(tǒng)，采取哪些新技術，如何確保技術實現。示范：僅供參考，不具備任何實質性的內容。4.1.1B/S結構體系示例4.1.2JAVA/JNDI技術示例4.1.3LDAP技術示例4.2安全策略從實現的角度來說明如何實現安全設計，采取哪些安全策略來確保新系統(tǒng)能滿足安全要求，如數據加密，CA認證、防火墻等。示范：僅供參考，不具備任何實質性的內容。4.3數據存儲備份策略說明應用系統(tǒng)如何實現數據存儲備份，應采取哪些策略，應遵循哪些存儲規(guī)則和規(guī)范。示范：僅供參考，不具備任何實質性的內容。4.4系統(tǒng)整合策略說明本應用系統(tǒng)如何與其他系統(tǒng)進行整合，如何整合，采取哪些技術策略，整合后的系統(tǒng)如何確保性能最優(yōu)，如何優(yōu)化。示范：僅供參考，不具備任何實質性的內容。五運行環(huán)境以圖表的形式列出新系統(tǒng)運行的服務器平臺環(huán)境，如操作系統(tǒng)、以及諸如IIS、Microsoft SQL Server之類的必要應用程序。同時，描述所有需要相關數據結構及身份驗證協議支持的特定需求。以圖表的形式列出客戶端環(huán)境需求與限制的相關細節(jié)，如CPU、操作系統(tǒng)、內存、存儲容量、硬件、應用軟件等。以圖表的形式列出服務器與客戶端以及遠程訪問所需要的網絡環(huán)境，如硬件環(huán)境（路由器、網關、防火墻等），網絡帶寬、傳輸速度、網絡協議等。5.1硬件環(huán)境列出硬件環(huán)境等信息。示范：僅供參考，不具備任何實質性的內容。 服務器端：取決于數據庫產品和應用服務器產品，應用程序本身沒有嚴格要求。 客戶端：奔騰133以上，32M以上內存。5.2軟件環(huán)境列出軟件環(huán)境等信息。示范：僅供參考，不具備任何實質性的內容。服務器端：操作系統(tǒng)：Windows 98 、Windows NT 4.0、Windows 2000中文版應用軟件：Office2000中文版，Excel和WordWEB服務：IIS+MS .Net FrameWork V1.14數據庫： SQL Server 2000開發(fā)平臺：Microsoft Visual Studio.Net客戶端：瀏覽程序：IE瀏覽器5.0版本或者以上5.3開發(fā)工具列出開發(fā)工具文件清單，包括出版單位、作者、版本、日期等信息。示范：僅供參考，不具備任何實質性的內容。六項目實施6.1工程實施內容列出具體的項目工程實施內容等信息。示范：僅供參考，不具備任何實質性的內容。根據對項目需求的分析以及金融快報的業(yè)務特點，初步確定工程的開發(fā)內容如下表：功能分類模塊開發(fā)內容系統(tǒng)管理快報版本管理模板管理對快報版本的維護報送模板管理模板管理對報送模板的維護采集模板管理模板管理對采集模板的維護采集指標管理系統(tǒng)基本管理對采集指標的維護報送指標管理系統(tǒng)基本管理對報送指標的維護轉換關系管理系統(tǒng)基本管理對指標的轉換關系維護報送規(guī)則管理系統(tǒng)配置對報表的報送規(guī)則維護時間序列指標管理系統(tǒng)基本管理對要生成時間序列指標數據采集數據報送數據上報對業(yè)務數據進行數據上報處理數據加、解鎖數據維護對已經上報的數據進行加、解鎖判斷和相關處理數據查看數據上報、數據維護查看已經上報的數據數據處理數據查看數據維護根據條件查看已經上報的數據數據修改數據維護對已經上報的數據和要生成的數據進行數據修改文件處理快報文件生成文件處理生成指定數據時間的快報文件，包括WORD文件和EXCEL文件快報文件下載文件處理下載已經生成的WORD文件和EXCEL文件時間序列文件生成文件處理生成指定數據時間和項目的時間序列文件時間序列文件下載文件處理下載已經生成的時間序列文件6.2工程實施計劃列出具體的項目工程實施計劃信息。示范：僅供參考，不具備任何實質性的內容。根據對開發(fā)內容的分析初步確定工程的實施計劃如下表： 編號階段任務描述起止時間1需求調研了解具體需求，形成調研報告2004-7-152004-7-312需求分析詳