总体设计,是架构师经常要写的文档。
总体设计文档,一般要写些什么呢?
除了需求模块,技术的部分至少应该包含设计目标,系统架构,模块简介与设计折衷这四个部分。
可以用产品的语言描述需求,怕麻烦的话,也可以拷贝需求文档的链接。(2)性能目标,是根据业务数据对系统性能进行的评估;(1)系统架构,一般会画一个架构图,并配以文字对架构进行简要说明;(2)模块简介嘛,是对架构图中多个模块的说明介绍;总体设计文档撰写完之后,要进行总体设计评审。总体设计评审的内容,主要就是方案的设计折衷,讨论各个方案的优缺点,并确认最终使用哪种方案。因此,总体设计文档里一定要说明,多个方案的优缺点,以供设计评审时讨论。如果设计文档里只有一种方案,那设计评审的意义便不大了,会演变为评审委员会帮助架构师思考方案的不足,以及临时提供解决方案。另外,在总体设计评审过后,也一定要更新文档,说明最终使用了哪种方案,以及为什么使用这种方案。有时候因为排期或者其他原因,不一定采用了最优的设计方案,此时更应该在文档中记录决策的过程与原因。如果不记录,别人拿到你设计的系统,设计方案可能完全就是个谜。另外,设计折衷是架构师进行自我辩解的最佳机会:因为项目进度,因为历史遗留问题,我不得不采取了这样一坨设计方案,情有可原,以后不要再骂我了。(1)总体设计文档,一般包含需求、设计目标、系统架构、模块介绍、设计折衷这5个部分;https://www.freecodecamp.org/news/how-to-write-a-good-software-design-document-66fcf019569c/==全文完==
以实践为主线,结合讲解架构知识点,几十个小时视频内容,已完结。以架构知识点为主线,结合讲实践。讲解形式:短视频+图文+直播+星球社群,免费,欢迎感兴趣的童鞋关注。