XXX架構設計說明書

(架構設計重點在于將系統分層并產生層次內的模塊、闡明模塊之間的關系)

一.  概述

描述本文的參考依據、資料以及大概內容。

二.  目的

描述本文編寫的目的。

三.  架構設計

闡明進行架構設計的總體原則,如對問題域的分析方法。

3.1.       架構分析

對場景以及問題域進行分析,構成系統的架構級設計,闡明對于系統的分層思想。

3.2.       設計思想

闡明進行架構設計的思想,可參考一些架構設計的模式,需結合當前系統的實際情況而定。

3.3.       架構體系

根據架構分析和設計思想產生系統的架構圖,并對架構圖進行描述,說明分層的原因、層次的職責,并根據架構圖繪制系統的物理部署圖,描述系統的部署體系。

3.4.       模塊劃分

根據架構圖進行模塊的劃分并闡明模塊劃分的理由,繪制模塊物理圖以及模塊依賴圖。

3.4.1.       模塊描述

根據模塊物理圖描述各模塊的職責,并聲明其對其他模塊的接口要求。。

3.4.2.       模塊接口設計

對模塊接口進行設計,并提供一定的偽代碼。

XXX概要設計說明書

(概要設計重點在于將模塊分解為對象并闡明對象之間的關系)

一.  概述

描述本文的參考依據、資料以及大概內容。

二.  目的

描述本文的編寫目的。

三.  模塊概要設計

引用架構設計說明書中的模塊圖,并闡述對于模塊進行設計的大致思路。

3.1.       設計思想

闡明概要設計的思想,概要設計的思想通常是涉及設計模式的。

3.2.       模塊A

3.2.1.       概要設計

根據該模塊的職責對模塊進行概要設計(分解模塊為對象、描述對象的職責以及聲明對象之間的接口),繪制模塊的對象圖、對象間的依賴圖以及模塊主要功能的序列圖,分別加以描述并相應的描述模塊異常的處理方法。

3.2.2.       模塊接口實現

闡明對于架構設計中定義的模塊接口的實現的設計。

XXX詳細設計說明書

(詳細設計重點在于對模塊進行實現,將模塊的對象分解為屬性和方法,并闡述如何實現)

 

一.  概述

闡述本文的參考依據、資料以及大概內容。

二.  目的

闡述本文的編寫目的。

三.  模塊詳細設計

3.1.       設計思想

闡述對模塊進行詳細設計的思想。

3.2.       模塊A

3.2.1.       詳細設計

根據模塊概要設計詳細描述對于模塊內對象的實現,包括對象的職責、屬性、方法、對象內功能的流程圖、對象關聯的類、對象的異常。(需要繪制的主要為類圖)