架构设计文档的一些心得
如果想成为一个架构师,那么写架构设计文档是一个必备的技能。架构设计文档包括哪些内容呢?架构设计文档应该是从上至下的方式去表达设计思路,设计主要有如下几个部分
设计概述
主要描述系统是干什么的,承担了什么职责
1.1功能概述
系统主要包括哪些功能
1.2功能约束
主要描述一些非功能性需求:
1.性能指标:例如默默交易单台机器要达到TPS>1000
2.系统可用性指标:99.99%
等
系统整体设计
2.1系统部署图
描述系统有多少个子系统,子系统直接有什么关系,有多少个外部系统,和外部系统如何通讯
2.2系统序列图
描述关键场景下子系统之间的序列表达
子系统设计
3.1系统组件图
描述系统拆分成多少个组件(模块),组件之间的关系是什么?
3.1.1组件序列图
关键场景下组件的序列图
3.2组件设计
3.2.1组件类图
描述组件关键代码设计类图
3.2.2组件类序列图
描述主组件关键类代码调用序列图
3.3.3组件内复杂的状态图
描述组件内比较复杂状态变化图
评论