嘮嘮叨叨:最近在寫概要設計文檔,發現自己的水平還是一般般,總想著怎么寫,如何寫,實際文檔的目的是溝通交流,重點不是寫得多高大上,重點是是否把問題說明白了!
當需求文檔出來以后,就可以著手寫概要設計文檔了,概要設計目的是從全局的角度給出這個項目或系統應該做什么、怎么做,內容一般包括如下幾個部分:
簡介
- 背景:簡單介紹下項目背景,如果是新產品/新功能,需要說明啟動項目的原因、背景、產品的定位、目標取舍、可預期的效果;如果是升級功能,說明升級原因、對現有系統有什么影響、可預期的效果;
- 名詞解釋:對文檔中新的或不常見的名詞、概念或簡略語給出定義和解釋;
- 功能需求:即這個項目要完成的需求功能;一般會有對應的MRD;
- 非功能需求:除了硬性的功能需求之外,還有處理延遲、吞吐量等非功能性需求;
- 系統運行環境:列出系統所需的軟硬件需求,包括操作系統、機器型號及配置要求,建議用表格列出,最好還有部署架構圖(也可以單獨出部署設計文檔,在此引用);
系統設計思路
針對項目的關鍵問題,給出多種設計思路,并對比各種思路的優缺點,最后給出,采用哪種思路,并在后面的概要設計中詳述。
概要設計
闡述系統的整體設計,一般會包括多個部分(沒部分負責一個模塊)
- 系統對外接口:即對外暴露的接口,如果比較復雜,可以編寫單獨的接口設計文檔,并在此引用。
- 架構圖和說明:把系統分解成若干個子系統或模塊,給出系統架構圖,并給出每個模塊完成的主要功能。
- 流程圖和說明:通過流程圖說明,各個模塊之間是如何交互來實現系統功能的。