|
雖然這些文檔一般來說公司都是有模板的,，但我寫這些文檔以來基本上是每寫一次就把目錄結(jié)構(gòu)給改一次，應(yīng)該說這是因?yàn)樽约簩@些文檔的理解開始加深,，慢慢的越來越明白這些文檔的作用和其中需要闡述的東西,，覺得這三份文檔主要闡述了一個(gè)系統(tǒng)的設(shè)計(jì)和實(shí)現(xiàn)過程，從系統(tǒng)分解為層次,、層次內(nèi)的模塊以及相互的接口,、模塊分解為對象以及對象的接口、實(shí)現(xiàn)這些對象接口的方法,。這次又整了一份,，^_^，歡迎大家指正,。 XXX架構(gòu)設(shè)計(jì)說明書 (架構(gòu)設(shè)計(jì)重點(diǎn)在于將系統(tǒng)分層并產(chǎn)生層次內(nèi)的模塊、闡明模塊之間的關(guān)系) 一. 概述 描述本文的參考依據(jù),、資料以及大概內(nèi)容,。 二. 目的 描述本文編寫的目的。 三. 架構(gòu)設(shè)計(jì) 闡明進(jìn)行架構(gòu)設(shè)計(jì)的總體原則,，如對問題域的分析方法,。 3.1. 架構(gòu)分析 對場景以及問題域進(jìn)行分析，構(gòu)成系統(tǒng)的架構(gòu)級設(shè)計(jì),，闡明對于系統(tǒng)的分層思想,。 3.2. 設(shè)計(jì)思想 闡明進(jìn)行架構(gòu)設(shè)計(jì)的思想,，可參考一些架構(gòu)設(shè)計(jì)的模式，需結(jié)合當(dāng)前系統(tǒng)的實(shí)際情況而定,。 3.3. 架構(gòu)體系 根據(jù)架構(gòu)分析和設(shè)計(jì)思想產(chǎn)生系統(tǒng)的架構(gòu)圖,，并對架構(gòu)圖進(jìn)行描述，說明分層的原因,、層次的職責(zé),，并根據(jù)架構(gòu)圖繪制系統(tǒng)的物理部署圖，描述系統(tǒng)的部署體系,。 3.4. 模塊劃分 根據(jù)架構(gòu)圖進(jìn)行模塊的劃分并闡明模塊劃分的理由,，繪制模塊物理圖以及模塊依賴圖。 3.4.1. 模塊描述 根據(jù)模塊物理圖描述各模塊的職責(zé),，并聲明其對其他模塊的接口要求,。。 3.4.2. 模塊接口設(shè)計(jì) 對模塊接口進(jìn)行設(shè)計(jì),，并提供一定的偽代碼,。 XXX概要設(shè)計(jì)說明書 (概要設(shè)計(jì)重點(diǎn)在于將模塊分解為對象并闡明對象之間的關(guān)系) 一. 概述 描述本文的參考依據(jù)、資料以及大概內(nèi)容,。 二. 目的 描述本文的編寫目的,。 三. 模塊概要設(shè)計(jì) 引用架構(gòu)設(shè)計(jì)說明書中的模塊圖，并闡述對于模塊進(jìn)行設(shè)計(jì)的大致思路,。 3.1. 設(shè)計(jì)思想 闡明概要設(shè)計(jì)的思想,，概要設(shè)計(jì)的思想通常是涉及設(shè)計(jì)模式的。 3.2. 模塊A 3.2.1. 概要設(shè)計(jì) 根據(jù)該模塊的職責(zé)對模塊進(jìn)行概要設(shè)計(jì)(分解模塊為對象,、描述對象的職責(zé)以及聲明對象之間的接口),，繪制模塊的對象圖、對象間的依賴圖以及模塊主要功能的序列圖,，分別加以描述并相應(yīng)的描述模塊異常的處理方法,。 3.2.2. 模塊接口實(shí)現(xiàn) 闡明對于架構(gòu)設(shè)計(jì)中定義的模塊接口的實(shí)現(xiàn)的設(shè)計(jì)。 XXX詳細(xì)設(shè)計(jì)說明書 (詳細(xì)設(shè)計(jì)重點(diǎn)在于對模塊進(jìn)行實(shí)現(xiàn),，將模塊的對象分解為屬性和方法,，并闡述如何實(shí)現(xiàn)) 一. 概述 闡述本文的參考依據(jù)、資料以及大概內(nèi)容,。 二. 目的 闡述本文的編寫目的,。 三. 模塊詳細(xì)設(shè)計(jì) 3.1. 設(shè)計(jì)思想 闡述對模塊進(jìn)行詳細(xì)設(shè)計(jì)的思想。 3.2. 模塊A 3.2.1. 詳細(xì)設(shè)計(jì) 根據(jù)模塊概要設(shè)計(jì)詳細(xì)描述對于模塊內(nèi)對象的實(shí)現(xiàn),，包括對象的職責(zé),、屬性、方法、對象內(nèi)功能的流程圖,、對象關(guān)聯(lián)的類,、對象的異常。(需要繪制的主要為類圖) |
|
|
