一个好的架构设计文档实践

#架构如何描述#

云原生架构边缘计算企业上云

一、架构描述

架构的定义:系统架构是概念的体现,是对物/信息的功能与形式元素之间的对应情况所做的分配,是对元素之间的关系以及元素同周边环境之间的关系所做的定义(摘自互联网)。一句话:干什么的、内部划分和关系、外部关系。

架构的目标或要求:

架构的表示方法:主流的有两种:

  • 4+1模型
  • C4模型

本文推荐4张图(业务架构、技术架构、基础架构、部署架构)

二、统一架构约束

为更好地实现架构目标,让读者更清楚了解架构整体情况与重点内容,减少歧义,需要明确目标对象、内容要求、责任主题,进行约束如下:

  • 内容达意要求
业务架构图 技术架构图 基础架构图 部署架构图
1 描述目标用户与应用场景 描述业务模块边界和功能归属 描述业务模块间支撑关系 描述系统内外边界和交互方式 描述技术组件选型和开发框架 描述系统内外部通信协议 描述数据存储与流转方式 描述跨AZ架构交互 底层平台或资源依赖 描述系统全局(多可用区)部署概况 描述AZ内网络拓扑、域隔离情况 描述组件之间的联通关系 描述系统各层高可用部署方案 描述系统详细部署情况,包括操作系统版本、IP地址、业务端口 描述产品资源池部署视图,明确版本、内容、规模等 描述核心业务数据流向、带宽等
2 业务规划、架构师 技术经理、架构师 部署人员、架构师 部署人员、架构师
  • 符号约束

为标准化《架构统一描述规范(四张图)》,针对常见的元素和关系符号进行建议约束,如箭头、实虚线、方框默认指代含义,便于形成描述标准。

1、字体:微软雅黑(正文)、按需加粗加色。

2、实体元素:业务模块、功能点

3、系统缩略:比如外部系统、子系统缩略等。

4、连线:默认采用黑色,包括实线、虚线(多种)、加粗线、折线、曲线,可根据需要改变颜色。

5、横纵向宽体箭头:横向表示工作流类、纵向表示支撑类,为避免和原图耦合,可通过立体效果体现。

6、绘制工具:采用ppt、visio,均可达到效果,支持二次编辑/开发即可。

三、最佳实践:

1、业务架构图

2、技术架构图

3、基础架构图

4、部署架构图:由于不同企业有不同的规范,不做约束。

注:贵在交流个人技术思想,欢迎留言反馈意见。

猜你喜欢

转载自blog.csdn.net/bishenghua/article/details/134957162