嘮嘮叨叨:最近在寫概要設(shè)計文檔,發(fā)現(xiàn)自己的水平還是一般般躏鱼,總想著怎么寫娩嚼,如何寫庶灿,實際文檔的目的是溝通交流,重點不是寫得多高大上窄做,重點是是否把問題說明白了愧驱!
當(dāng)需求文檔出來以后,就可以著手寫概要設(shè)計文檔了椭盏,概要設(shè)計目的是從全局的角度給出這個項目或系統(tǒng)應(yīng)該做什么组砚、怎么做,內(nèi)容一般包括如下幾個部分:
簡介
- 背景:簡單介紹下項目背景掏颊,如果是新產(chǎn)品/新功能糟红,需要說明啟動項目的原因、背景乌叶、產(chǎn)品的定位改化、目標(biāo)取舍、可預(yù)期的效果枉昏;如果是升級功能,說明升級原因揍鸟、對現(xiàn)有系統(tǒng)有什么影響兄裂、可預(yù)期的效果句旱;
- 名詞解釋:對文檔中新的或不常見的名詞、概念或簡略語給出定義和解釋晰奖;
- 功能需求:即這個項目要完成的需求功能谈撒;一般會有對應(yīng)的MRD;
- 非功能需求:除了硬性的功能需求之外匾南,還有處理延遲啃匿、吞吐量等非功能性需求;
- 系統(tǒng)運行環(huán)境:列出系統(tǒng)所需的軟硬件需求蛆楞,包括操作系統(tǒng)溯乒、機器型號及配置要求,建議用表格列出豹爹,最好還有部署架構(gòu)圖(也可以單獨出部署設(shè)計文檔裆悄,在此引用);
系統(tǒng)設(shè)計思路
針對項目的關(guān)鍵問題臂聋,給出多種設(shè)計思路光稼,并對比各種思路的優(yōu)缺點,最后給出孩等,采用哪種思路艾君,并在后面的概要設(shè)計中詳述。
概要設(shè)計
闡述系統(tǒng)的整體設(shè)計肄方,一般會包括多個部分(沒部分負(fù)責(zé)一個模塊)
- 系統(tǒng)對外接口:即對外暴露的接口冰垄,如果比較復(fù)雜,可以編寫單獨的接口設(shè)計文檔扒秸,并在此引用播演。
- 架構(gòu)圖和說明:把系統(tǒng)分解成若干個子系統(tǒng)或模塊,給出系統(tǒng)架構(gòu)圖伴奥,并給出每個模塊完成的主要功能写烤。
- 流程圖和說明:通過流程圖說明,各個模塊之間是如何交互來實現(xiàn)系統(tǒng)功能的拾徙。