架構(gòu)設(shè)計說明書

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

2、構(gòu)圖/類圖74.2. 功能定義74.3. 功能需求與系統(tǒng)模塊的關(guān)系 85. 接口設(shè)計85.1. 用戶接口 85.2. 外部接口 85.3. 內(nèi)部接口 86. 系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計96.1. 邏輯結(jié)構(gòu)設(shè)計96.2. 物理結(jié)構(gòu)設(shè)計 96.3. 配置文件結(jié)構(gòu)設(shè)計96.4. 數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系 97. 算法設(shè)計98. 運行設(shè)計108.1. 運行模塊組合 108.2. 運行控制108.3. 運行時間109. 系統(tǒng)安全109.1. 8.1系統(tǒng)安全109.2. 8.2數(shù)據(jù)安全 109.3. 8.3備份與恢復(fù) 11948.4出錯處理1110. 系統(tǒng)維護設(shè)計1111. 系統(tǒng)部署1111.1. 軟硬件環(huán)境1111.

3、2. 系統(tǒng)部署1111.3. 系統(tǒng)升級1112. 遺留問題121.引言1.1. 編寫目的說明編寫這份架構(gòu)設(shè)計說明書的目的，指出預(yù)期的讀者。1.2. 系統(tǒng)目標(biāo)本系統(tǒng)要達成的目標(biāo)，應(yīng)描述架構(gòu)設(shè)計的細度及為下一步模塊設(shè)計提供的支持。1.3. 術(shù)語和縮寫詞定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4. 參考資料列出與本文密切相關(guān)的參考資料，可能包含如下內(nèi)容：本項目經(jīng)核準(zhǔn)的計劃任務(wù)書或合同、上級主管的批文；屬于本項目的其它已發(fā)表的文件；本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明如何能夠得到這些資料。2. 需

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

5、與舊版本的兼容升級關(guān)系等3. 總體結(jié)構(gòu)設(shè)計3.1. 系統(tǒng)體系結(jié)構(gòu)確定系統(tǒng)采用何種體系結(jié)構(gòu)，如：單機版還是網(wǎng)絡(luò)版？C/S結(jié)構(gòu)還是 B/S結(jié)構(gòu)？兩層結(jié)構(gòu)還是多層結(jié)構(gòu)？分布式數(shù)據(jù)庫還是集中式數(shù)據(jù)庫？分布式應(yīng)用程序服務(wù)器還是集中式應(yīng)用程序服務(wù)器？是采用.Net應(yīng)用程序框架還是 J2EE應(yīng)用程序框架？3.2. 系統(tǒng)開發(fā)的基礎(chǔ)平臺和關(guān)鍵組件3.2.1. 外部基礎(chǔ)平臺和關(guān)鍵組件確定系統(tǒng)開發(fā)的外部基礎(chǔ)平臺和關(guān)鍵組件，如:是在 Windows平臺、Unix平臺或者 Linux平臺上開發(fā)？還是平臺無關(guān)性？是否是在某些軟件上作二次開發(fā)？如AutoCAD。是否采用一些第三方的關(guān)鍵組件。3.2.2. 內(nèi)部基礎(chǔ)平臺和關(guān)鍵

6、組件確定系統(tǒng)開發(fā)所使用的公司內(nèi)部開發(fā)平臺、組件/控件、公共函數(shù)/單元等公共資源，如：是否在GSP平臺上開發(fā)；是否采用公司的報表控件；是否復(fù)用公司其他產(chǎn)品的架構(gòu)或資源等。3.3. 總體結(jié)構(gòu)給出系統(tǒng)結(jié)構(gòu)總體框圖（包括軟件、硬件結(jié)構(gòu)框圖），說明本系統(tǒng)的各模塊的劃分，扼要說明每個系統(tǒng)模塊的標(biāo)識符和功能，分層次地給出各模塊之間的控制與被控制關(guān)系。如果采用結(jié)構(gòu)化分析方法，通常采用下面兩種模型來描述總體結(jié)構(gòu)：結(jié)構(gòu)圖（層次圖）：對系統(tǒng)自頂向下進行分解。系統(tǒng)流程圖：描述子系統(tǒng)內(nèi)部的控制流和數(shù)據(jù)流如果采用面向?qū)ο蟮姆治龇椒?，通常采用包（package）圖來描述總體結(jié)構(gòu)。包（package）圖描述了子系統(tǒng)之間的包含

7、關(guān)系和依賴關(guān)系。4. 子系統(tǒng)設(shè)計在總體結(jié)構(gòu)設(shè)計中已經(jīng)將系統(tǒng)劃分為若干個子系統(tǒng)，在此需要對所有的子系統(tǒng)進行設(shè)計。一般 應(yīng)包括下列內(nèi)容。4.1. 功能結(jié)構(gòu)圖/類圖結(jié)構(gòu)化設(shè)計：對結(jié)構(gòu)圖進行細化，分解到功能一級。面向?qū)ο笤O(shè)計：對包（package ）圖進行細化，確定各包中包含的類。4.2. 功能定義說明上一步分解的所有功能組件（功能模塊或者類）的功能。序號功能/類名稱功能描述12RTM（需求跟蹤）4.3. 功能需求與系統(tǒng)模塊的關(guān)系本條用一張矩陣圖說明各項功能需求的實現(xiàn)同各模塊的分配關(guān)系，用來實現(xiàn) 表，如果已經(jīng)采用了外部工具來做，此處可以省略。需求跟蹤表系統(tǒng)模塊1系統(tǒng)模塊2系統(tǒng)模塊m功能需求1V功能需求

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

9、的每個數(shù)據(jù)結(jié)構(gòu)的名稱、標(biāo)識符以及它們之中每個數(shù)據(jù)項、記錄、文卷和 系的標(biāo)識、定義、長度及它們之間的層次的或表格的相互關(guān)系。6.2. 物理結(jié)構(gòu)設(shè)計給出本系統(tǒng)內(nèi)所使用的每個數(shù)據(jù)結(jié)構(gòu)中的每個數(shù)據(jù)項的存儲要求，訪問方法、存取單位、存取 的物理關(guān)系、設(shè)計考慮和保密條件。6.3. 配置文件結(jié)構(gòu)設(shè)計給出本系統(tǒng)內(nèi)所使用的每個配置文件中數(shù)據(jù)結(jié)構(gòu)中的每個數(shù)據(jù)項的存儲要求，訪問方法、具體 的含義和設(shè)計考慮等。6.4. 數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系說明各個數(shù)據(jù)結(jié)構(gòu)與訪問這些數(shù)據(jù)結(jié)構(gòu)的各個程序之間的對應(yīng)關(guān)系。模塊1模塊2模塊m數(shù)據(jù)結(jié)構(gòu)1V數(shù)據(jù)結(jié)構(gòu)2VV數(shù)據(jù)結(jié)構(gòu)nVV7. 算法設(shè)計算法設(shè)計也可以在詳細設(shè)計或?qū)崿F(xiàn)階段進行;對涉及到

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

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