1、架構設計說明書項目名稱：項目名稱項目代號：項目代號編制人：編制人編制日期：編制日期修訂記錄版本日期撰寫/修訂人備注/修訂內容目 錄架構設計說明書11.引言51.1.編寫目的51.2.系統(tǒng)目標51.3.術語和縮寫詞定義51.4.參考資料52.需求規(guī)定52.1.系統(tǒng)功能52.2.系統(tǒng)性能52.3.故障處理要求62.4.軟硬件要求62.5.其他需求限制條件63.總體結構設計63.1.系統(tǒng)體系結構63.2.系統(tǒng)開發(fā)的基礎平臺和關鍵組件63.2.1.外部基礎平臺和關鍵組件63.2.2.內部基礎平臺和關鍵組件73.3.總體結構74.子系統(tǒng)設計74.1.功能結構圖/類圖74.2.功能定義74.3.功能需求與

2、系統(tǒng)模塊的關系85.接口設計85.1.用戶接口85.2.外部接口85.3.內部接口86.系統(tǒng)數據結構設計86.1.邏輯結構設計96.2.物理結構設計96.3.配置文件結構設計96.4.數據結構與程序的關系97.算法設計98.運行設計98.1.運行模塊組合108.2.運行控制108.3.運行時間109.系統(tǒng)安全 系統(tǒng)安全 數據安全 備份與恢復 出錯處理1110.系統(tǒng)維護設計1111.系統(tǒng)部署1111.1.軟硬件環(huán)境1111.2.系統(tǒng)部署1111.3.系統(tǒng)升級1112.遺留問題111. 引言1.1. 編寫目的說明編寫這份架構設

3、計說明書的目的，指出預期的讀者。1.2. 系統(tǒng)目標本系統(tǒng)要達成的目標，應描述架構設計的細度及為下一步模塊設計提供的支持。1.3. 術語和縮寫詞定義列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組。 1.4. 參考資料列出與本文密切相關的參考資料，可能包含如下內容：l 本項目經核準的計劃任務書或合同、上級主管的批文；l 屬于本項目的其它已發(fā)表的文件；l 本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標準。列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位，說明如何能夠得到這些資料。2. 需求規(guī)定說明影響架構設計的系統(tǒng)主要功能、輸入輸出、性能要求等的需求限制條件。2.1. 系統(tǒng)功能

4、系統(tǒng)的功能性需求，主要列出對架構設計產品影響的典型功能要求、數據要求、輸入輸出要求和界面要求等。2.2. 系統(tǒng)性能主要包括l 數據精度l 執(zhí)行效率l 數據處理能力等的要求。2.3. 故障處理要求系統(tǒng)出現故障時的處理機制，比如：故障轉移等。2.4. 軟硬件要求軟件需求規(guī)格中規(guī)定必須支持的軟硬件環(huán)境。2.5. 其他需求限制條件包括：l 事先約定必須要使用的商業(yè)上架系統(tǒng)/組件（比如：必須在MS Office上做二次開發(fā)）；l 必須應用的技術（比如：必須使用B/S結構）；l 必須要與某商業(yè)軟件做接口（比如：必須與用友軟件做接口）；l 與舊版本的兼容升級關系等3. 總體結構設計3.1. 系統(tǒng)體系結構確定

5、系統(tǒng)采用何種體系結構，如：l 單機版還是網絡版？l C/S結構還是B/S結構？l 兩層結構還是多層結構？l 分布式數據庫還是集中式數據庫？l 分布式應用程序服務器還是集中式應用程序服務器？l 是采用.Net應用程序框架還是J2EE應用程序框架？3.2. 系統(tǒng)開發(fā)的基礎平臺和關鍵組件3.2.1. 外部基礎平臺和關鍵組件確定系統(tǒng)開發(fā)的外部基礎平臺和關鍵組件，如：l 是在Windows平臺、Unix平臺或者Linux平臺上開發(fā)？還是平臺無關性？l 是否是在某些軟件上作二次開發(fā)？如AutoCAD。 l 是否采用一些第三方的關鍵組件。3.2.2. 內部基礎平臺和關鍵組件確定系統(tǒng)開發(fā)所使用的公司內部開發(fā)平

6、臺、組件/控件、公共函數/單元等公共資源，如：l 是否在GSP平臺上開發(fā)；l 是否采用公司的報表控件；l 是否復用公司其他產品的架構或資源等。3.3. 總體結構給出系統(tǒng)結構總體框圖（包括軟件、硬件結構框圖），說明本系統(tǒng)的各模塊的劃分，扼要說明每個系統(tǒng)模塊的標識符和功能，分層次地給出各模塊之間的控制與被控制關系。如果采用結構化分析方法，通常采用下面兩種模型來描述總體結構：l 結構圖（層次圖）：對系統(tǒng)自頂向下進行分解。l 系統(tǒng)流程圖：描述子系統(tǒng)內部的控制流和數據流如果采用面向對象的分析方法，通常采用包(package)圖來描述總體結構。包(package)圖描述了子系統(tǒng)之間的包含關系和依賴關系。4

7、. 子系統(tǒng)設計在總體結構設計中已經將系統(tǒng)劃分為若干個子系統(tǒng)，在此需要對所有的子系統(tǒng)進行設計。一般應包括下列內容。4.1. 功能結構圖/類圖結構化設計：對結構圖進行細化，分解到功能一級。面向對象設計：對包（package）圖進行細化，確定各包中包含的類。4.2. 功能定義說明上一步分解的所有功能組件（功能模塊或者類）的功能。序號功能/類名稱功能描述124.3. 功能需求與系統(tǒng)模塊的關系本條用一張矩陣圖說明各項功能需求的實現同各模塊的分配關系，用來實現RTM（需求跟蹤）表，如果已經采用了外部工具來做，此處可以省略。需求跟蹤表系統(tǒng)模塊1系統(tǒng)模塊2系統(tǒng)模塊m功能需求1功能需求2功能需求n5. 接口設計

8、5.1. 用戶接口說明將向用戶提供的命令和它們的語法結構，以及相應的回答信息。例如：腳本命令語法等。5.2. 外部接口說明本系統(tǒng)同外界的所有接口的安排包括：l 軟件與硬件之間的接口；l 本系統(tǒng)與各支持系統(tǒng)之間的接口；l 本系統(tǒng)支持擴展性預留的外部接口及擴展的方式。l 如果需要對外提供API接口，列出API接口。5.3. 內部接口說明本系統(tǒng)之內的各個系統(tǒng)模塊或元素之間的接口的安排，包括：l 系統(tǒng)涉及的全局變量與接口函數；l 本系統(tǒng)支持擴展性預留的內部擴展點及擴展的方式等。6. 系統(tǒng)數據結構設計數據庫結構設計遵循數據庫設計規(guī)范，此規(guī)范文檔單獨提供。6.1. 邏輯結構設計給出本系統(tǒng)內所使用的每個數據

9、結構的名稱、標識符以及它們之中每個數據項、記錄、文卷和系的標識、定義、長度及它們之間的層次的或表格的相互關系。6.2. 物理結構設計給出本系統(tǒng)內所使用的每個數據結構中的每個數據項的存儲要求，訪問方法、存取單位、存取的物理關系、設計考慮和保密條件。6.3. 配置文件結構設計給出本系統(tǒng)內所使用的每個配置文件中數據結構中的每個數據項的存儲要求，訪問方法、具體的含義和設計考慮等。6.4. 數據結構與程序的關系說明各個數據結構與訪問這些數據結構的各個程序之間的對應關系。模塊1模塊2模塊m數據結構1數據結構2數據結構n7. 算法設計算法設計也可以在詳細設計或實現階段進行；對涉及到大量數據運算和實時性要求高

10、的組件，需對將采用的算法進行闡述、論證，以確保合理使用系統(tǒng)資源、滿足需求規(guī)格說明書中的系統(tǒng)性能要求。8. 運行設計運行設計主要考慮軟件在對外發(fā)布時所提供的根據用戶特點的定制能力。比如：通過修改配置文件來顯示或隱藏某些模塊，通過修改配置文件來組合某些模塊等8.1. 運行模塊組合說明對系統(tǒng)施加不同的外界運行控制時所引起的各種不同的運行模塊組合，說明每種運行所歷經的內部模塊的支持軟件。模塊集合運行條件支持軟件8.2. 運行控制說明每一種外界的運行控制的方式方法和操作步驟。運行名稱控制方法操作步驟8.3. 運行時間說明每種運行模塊組合將占用各種資源的時間，此項一般可以省略。運行名稱所占資源時間9. 系

11、統(tǒng)安全9.1. 系統(tǒng)安全1系統(tǒng)安全控制和物理保護措施，比如：程序加密（軟件鎖）。；2用戶身份鑒別機制；3用戶對系統(tǒng)的訪問權限和范圍。9.2. 數據安全根據需求規(guī)格說明書中的系統(tǒng)保密要求，對系統(tǒng)進入及數據保密功能進行設計。通常指：數據加密、數據用戶身份鑒別、數據庫本身的安全（比如異常情況的數據保護、并發(fā)控制）等。9.3. 備份與恢復1數據備份；2數據恢復；3恢復及再啟動技術。說明將使用的恢復再啟動技術，使軟件從故障點恢復執(zhí)行或使軟件從頭開始重新運行的方法。9.4. 出錯處理1) 出錯的情況；2) 出錯時信息輸出的形式、信息的含義和反饋處理方法；3) 出錯失效后的后備處理措施。10. 系統(tǒng)維護設計維護功能是系統(tǒng)的重要組成部分，應提供系統(tǒng)維護和管理的方法和工具。此處說明為了系統(tǒng)維護的方便而在程序內部設計中作出的安排，包括在程序中專門安排用于系統(tǒng)檢查與維護的檢測點和專用模塊及工具。11. 系統(tǒng)部署11.1. 軟硬件環(huán)境列出運行該軟件所需要的軟硬設備及其專門功能，如果是多層結構需要分別列出各層所需的軟硬件環(huán)境。11.2. 系統(tǒng)部署