实践篇(三):如何有效评审软件架构图?

作者:京东科技  倪新明

设计意图的传达是架构可视化关注的重要维度,在技术方案评审过程中不可避免的会出现各种各样的架构图或设计图,这些图形化表述在设计意图传达效果层面表现不一,本文从图形化的视角为软件架构图的评审关注点提供了参考。

注:关于架构及架构可视化参考文章 《 探寻软件架构的本质,到底什么是架构?》 《 软件架构可视化及C4模型:架构设计不仅仅是UML》

1 原则

明确的主题:架构图要表达的意图明确,比如是容器图、组件图还是部署图

一致的抽象层级:保持一致的抽象层级,不应超过2个以上的层次变化

粒度合适的范围:不应试图在一张图表达“所有的东西”,每张架构图聚焦于自身职责边界的范围

清晰的图例说明:对架构图颜色、形状等有明确的图例,以方便阅读导航

图形颜色不宜太多:过多颜色增加认知成本,建议不超过 4 种

图形元素不宜太多:过多图形元素增加认知成本

明确的连线关系描述

2 评审检查单

如同上线检查单和开发检查单,针对于软件架构图的评审制定一套检查单同样具有价值。不论架构设计者,还是参与设计评审的开发人员,对于形式各异的 “架构图” 是提供通用的参考关注点,以便干系人更多、更深入、更高效、更有针对性的获取架构图的更多信息。

2.1 通用检查项

架构图是否具有标题?

是否能够理解架构图的类型是什么?

是否能够理解架构图的范围是什么?

架构图是否有图例

2.2 元素

架构图中每一个元素是否有名字

是否能够理解架构图中每个元素的类型? (比如,抽象级别,软件系统?容器?组件?等等)

是否能够理解架构图中的每个元素是做什么的?简要描述信息?

是否能够理解与该元素相关的技术选型(适合标明技术选型的元素)

是否能够理解架构图中使用的所有缩写/简称的含义?

是否能够理解架构图中元素使用的所有颜色的含义

是否能够理解架构图中元素使用的所有形状的含义

是否能够理解架构图中元素使用的所有图标的含义?

是否能够理解架构图中元素使用的所有边框样式的含义? (比如,实线 vs 虚线)

是否能够理解架构图中使用的所有元素大小的含义? (比如, 小框 vs 大框 )

2.3 关联关系

架构图中的每条线是否有描述关系含义的信息?

是否能够理解架构图中的每个关联关系****(适合标明技术选型的场景技术选型是什么? (比如,进程间的交互的协议)

是否能够理解架构图中的关联关系的简称或缩写

是否能够理解架构图中的连线颜色的含义?

是否能够理解架构图中的连线箭头的含义?

是否能够理解架构图中的连线样式的含义? (比如,实线 vs 虚线)

3 结语

本文描述了软件架构图的一些评审关注点,其实不只是评审的视角,对于任何一个图形化的软件系统架构或设计表诉,如何能够快速的了解其要表达的意图至关重要,对于设计者而言如何快速传递架构设计信息并于干系人达成一致也至关重要。

优秀的个人博客,低调大师

微信关注我们

原文链接:https://my.oschina.net/u/4090830/blog/8077457

转载内容版权归作者及来源网站所有!

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

相关文章

发表评论

资源下载

更多资源
优质分享Android(本站安卓app)

优质分享Android(本站安卓app)

近一个月的开发和优化,本站点的第一个app全新上线。该app采用极致压缩,本体才4.36MB。系统里面做了大量数据访问、缓存优化。方便用户在手机上查看文章。后续会推出HarmonyOS的适配版本。

Oracle Database,又名Oracle RDBMS

Oracle Database,又名Oracle RDBMS

Oracle Database,又名Oracle RDBMS,或简称Oracle。是甲骨文公司的一款关系数据库管理系统。它是在数据库领域一直处于领先地位的产品。可以说Oracle数据库系统是目前世界上流行的关系数据库管理系统,系统可移植性好、使用方便、功能强,适用于各类大、中、小、微机环境。它是一种高效率、可靠性好的、适应高吞吐量的数据库方案。

Eclipse(集成开发环境)

Eclipse(集成开发环境)

Eclipse 是一个开放源代码的、基于Java的可扩展开发平台。就其本身而言,它只是一个框架和一组服务,用于通过插件组件构建开发环境。幸运的是,Eclipse 附带了一个标准的插件集,包括Java开发工具(Java Development Kit,JDK)。

Sublime Text 一个代码编辑器

Sublime Text 一个代码编辑器

Sublime Text具有漂亮的用户界面和强大的功能,例如代码缩略图,Python的插件,代码段等。还可自定义键绑定,菜单和工具栏。Sublime Text 的主要功能包括:拼写检查,书签,完整的 Python API , Goto 功能,即时项目切换,多选择,多窗口等等。Sublime Text 是一个跨平台的编辑器,同时支持Windows、Linux、Mac OS X等操作系统。