概要設(shè)計模板VIP

1、XX系統(tǒng)架構(gòu)設(shè)計說明書Architecture Design DocumentV: product version (產(chǎn)品發(fā)布，重大功能變更。01-99)R: product release (產(chǎn)品發(fā)布，小型功能變更/延伸，一般是客戶正式變更請求的結(jié)果。01-99)r: revision (內(nèi)部版本，開發(fā)過程中的修正。01-99)狀態(tài)：草稿狀態(tài)流程：草稿 -> 評審 -> 批準 -> 完成文檔編號：XXX-ZZZ-CCC-99-VVRRrr-YYYYMMDDXXX：產(chǎn)品縮寫: 如MC1(MetroCentre)ZZZ：文件類別Software Requirements Spe

2、cificationSRSSoftware Architecture DesignSADSoftware High Level DesignHLDSoftware Low Level DesignLLDSoftware Project PlanSPPSystem Test PlanSTPIntegration Test PlanITPUnit Test PlanUTPProject Closure ReportPCRSoftware User ManualSUMCCC：模塊識別（根據(jù)項目。由項目組長統(tǒng)一指定）99：序列號（識別模塊下的每個文件。由項目組長統(tǒng)一指定）VVRRrr：版本號YYYYM

3、MDD 文件完成時間，年月日初擬日期：YYYY-MM-DD完成日期：YYYY-MM-DD作者: NMS項目組部門: NMSR&D批準簽字項目組長項目經(jīng)理部門經(jīng)理高級經(jīng)理注：本文檔符合ISO 9001:2000和CMM L3標準。索引 Table Of Contents產(chǎn)品名稱 架構(gòu)設(shè)計說明書1Architecture Design Document1索引 Table Of Contents2修改記錄 Revisions3評審記錄 Reviews31. 緒論 Introduction41.1 目的 Purpose41.2 系統(tǒng)概括 System Overview41.3 術(shù)語、定義、縮寫

4、 Definitions, Acronyms, Abbreviations41.4 參考資料 Related Documentation42. 總體設(shè)計考慮 Design Considerations52.1 需求規(guī)定 Requirements Provision52.2 假設(shè)和約束 Assumptions and Dependencies52.3 運行環(huán)境 Operational Environment52.4 基本設(shè)計概念 Design Methodology52.5 尚未解決的問題 Unsolved Issues53. 系統(tǒng)架構(gòu) System Architecture63.1 系統(tǒng)配置S

5、ystem configuration6硬件配置Hardware configuration6網(wǎng)絡配置Network configuration6數(shù)據(jù)庫Databases63.2 軟件平臺Software platform64. 軟件系統(tǒng)構(gòu)架Software Architecture74.1 整體軟件架構(gòu)74.2 系統(tǒng)通信機制74.3 運行模塊組合 Runtime Module Integration74.4 子系統(tǒng)，模塊 1.n75. 系統(tǒng)協(xié)作流程 Inter-component coordination75.1 功能組1.n7Feature ID - 功能名稱 Feature name76

6、. 接口設(shè)計 Interface Design96.1 用戶接口 User Interface96.2 外部接口 External Interface96.3 內(nèi)部接口 Internal Interface97. 異常處理設(shè)計 Exception Handling Design107.1 異常處理原理和規(guī)范Exception Handling Principle107.2 異常定義 Exceptions Definitions108. 架構(gòu)設(shè)計策略及決定Strategies and Decisions11Strategy 1.n118.2 重用策略Reuse Strategies119. 結(jié)論

7、 Conclusions11修改記錄 Revisions版本作者修改內(nèi)容/原因日期VYYYY-MM-DD評審記錄 Reviews評審人日期評論意見緒論 Introduction本文檔摘要內(nèi)容。軟件產(chǎn)品的架構(gòu)設(shè)計，目的是為了定義軟件系統(tǒng)的綜合結(jié)構(gòu)和開發(fā)方式，做出最高層的設(shè)計決定，包括：系統(tǒng)的所有模塊，硬軟件/網(wǎng)絡配置，數(shù)據(jù)庫，軟件平臺，各系統(tǒng)模塊的功能、行為、接口，模塊之間的通信和交互方式，重用策略，異常處理策略；其重要在于這些決定一般較難反逆，并且對于整個產(chǎn)品的功能和性能影響較大。目的 Purpose標識要開發(fā)的軟件產(chǎn)品（名稱，代碼）。開發(fā)本軟件開發(fā)的意圖、應用目標。本文檔的預期讀者。系統(tǒng)概括

8、 System Overview系統(tǒng)結(jié)構(gòu)，功能，接口的高層敘述。術(shù)語、定義、縮寫 Definitions, Acronyms, Abbreviations本軟件中專門術(shù)語的定義以及英語縮寫詞的原詞組。 名稱縮寫中文釋義參考資料 Related Documentation文檔名稱版本/日期作者或來源備注項目可行性報告軟件需求定義軟件測試需求V NMSRnD(CVS path)MC系統(tǒng)描述TMF 814V 2.0XXX書某某，出版社(Copy availability)相關(guān)NMS信息注：可適當?shù)貏h除或添加文檔項?？傮w設(shè)計考慮 Design Considerations需求規(guī)定 Requiremen

9、ts Provision說明對本系統(tǒng)的主要的輸入輸出項目、處理的功能性能要求，詳細的說明可參見“軟件需求說明書”。假設(shè)和約束 Assumptions and Dependencies 對于軟件的假設(shè)和約束，包括使用，環(huán)境，規(guī)范，等。描述將影響軟件設(shè)計的限制：技術(shù)限制，性能要求，用戶特性，正確性要求，等。參見”軟件需求說明書”。運行環(huán)境 Operational Environment簡要地說明對本系統(tǒng)的運行環(huán)境（包括硬件環(huán)境和支持環(huán)境）的規(guī)定，詳細說明參見“軟件需求說明書”。（這里說明的是運行環(huán)境對于系統(tǒng)的要求和限制，不是系統(tǒng)本身的環(huán)境配置。系統(tǒng)的環(huán)境配置和選擇在“0系統(tǒng)配置Syste

10、m configuration”描述。）基本設(shè)計概念 Design Methodology說明本系統(tǒng)的基本設(shè)計概念，盡量使用圖表的形式：尚未解決的問題 Unsolved Issues說明在概要設(shè)計過程中尚未解決而設(shè)計者認為在系統(tǒng)完成之前必須解決的各個問題。系統(tǒng)架構(gòu) System Architecture系統(tǒng)配置System configuration 系統(tǒng)整體的硬件，網(wǎng)絡，軟件，數(shù)據(jù)庫，等配置的結(jié)構(gòu)圖：硬件配置Hardware configuration 網(wǎng)絡配置Network configuration 數(shù)據(jù)庫Databases軟件平臺Software platform系統(tǒng)使用什么軟件平臺，

11、技術(shù)（如GIS、J2EE、CORBA、數(shù)據(jù)庫訪問技術(shù)、等）。軟件系統(tǒng)構(gòu)架Software Architecture整體軟件架構(gòu)用一覽表及框圖的形式說明本系統(tǒng)的系統(tǒng)模塊的劃分，扼要說明每個系統(tǒng)模塊的標識符和功能，給出各模塊之間的關(guān)系。重點是為什么系統(tǒng)如此分化，而不是每個模塊細節(jié)。系統(tǒng)通信機制用一覽表及框圖的形式說明系統(tǒng)模塊之間的通信機制或交互機制。運行模塊組合 Runtime Module Integration說明對系統(tǒng)施加不同的外界運行控制時所引起的各種不同的運行模塊組合，說明每種運行所歷經(jīng)的內(nèi)部模塊和支持軟件。子系統(tǒng)，模塊 1.n描述每個系統(tǒng)模塊，模塊內(nèi)容包括：1 結(jié)構(gòu)設(shè)計；2 主要功能，

12、提供的服務，業(yè)務流程；3 和其他模塊的通信機制；等。系統(tǒng)協(xié)作流程 Inter-component coordination用一系列sequence diagram序列圖說明系統(tǒng)如何通過模塊之間的協(xié)作和交互，完成系統(tǒng)的主要功能。（系統(tǒng)功能來源于軟件需求定義的功能列表）功能組1.n(可以把系統(tǒng)的功能列表分成若干個功能組)Feature ID - 功能名稱 Feature name序列圖：說明完成該功能，系統(tǒng)各模塊之間的交互。另外，應該有序列圖每個步驟的描述。1 序列圖第一步。2 序列圖第二步。3 。接口設(shè)計 Interface Design用戶接口 User Interface說明將向用戶提供的命

13、令和它們的語法結(jié)構(gòu)，以及軟件的回答信息。(用戶圖形界面接口可以通過界面圓形描述。)外部接口 External Interface說明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持軟件之間的接口關(guān)系。接口名稱發(fā)源接收目標接口參數(shù)（輸入/返回/異常）接口說明（數(shù)據(jù)/狀態(tài)改變/結(jié)果）內(nèi)部接口 Internal Interface說明本系統(tǒng)之內(nèi)的各個系統(tǒng)模塊之間的接口的安排。接口名稱發(fā)源接收目標接口參數(shù)（輸入/返回/異常）接口說明（數(shù)據(jù)/狀態(tài)改變/結(jié)果）異常處理設(shè)計 Exception Handling Design異常處理原理和規(guī)范Exception Handling Prin

14、ciple說明系統(tǒng)處理異常的標準機制及原理。在每個模塊/層次的處理原則，何時向用戶通報，等等。異常定義 Exceptions Definitions說明系統(tǒng)可能出現(xiàn)異常的情況，以及處理的方法。模塊Exception/ErrorError Code異常起源內(nèi)部/外部處理方法說明架構(gòu)設(shè)計策略及決定Strategies and Decisions描述設(shè)計使用的策略，或影響系統(tǒng)總體結(jié)構(gòu)的決定。包括一些機制，手段，關(guān)鍵問題的解決。Strategy 1.n目標：Objective選擇的解決方法：Solution Selected選擇理由/標準：Selection Rationale其他選擇：Alterna

15、tives Considered重用策略Reuse Strategies說明對于軟件邏輯/代碼重用的決定和策略。結(jié)論 Conclusions文檔結(jié)論。未來工作。完成核對表Completion checklistü The Architecture Design document conforms to the organization standards.i. 使用最新的設(shè)計文檔模板，并填寫適當?shù)膬?nèi)容ii. 通過相應的文檔檢查checklistü All architectural decisions traceable back to a specific system

16、requirement.i. 需求跟蹤：架構(gòu)設(shè)計中的決定應該和系統(tǒng)需求有明確對應ü Modules/components are well defined, including their functionality and interfaces to other modules.i. 模塊定義：詳細描述每個模塊的功能、對外提供的服務接口ii. 接口定義：除了名字、輸入、輸出（可能是示意），還必須描述接口方法的目的、發(fā)出及接收的對象、以及對于接收對象內(nèi)部狀態(tài)的改變（如數(shù)據(jù)庫內(nèi)容）ü All the features/use-cases listed in the requirements correctly addressed with sequences of component collaborations.i. 序列圖：針對每個feature，必須有一個或一組序列