嵌入式工程师如何画出优秀的技术架构图

2023-03-28 12:19:12    来源:面包芯语

点击下方【一起学嵌入式】关注,一起学习,一起成长

嵌入式工程师如何写出高质量的技术文档

写技术文档,当然少不了要画图,流程图、架构图等等,那如何将文档中的图画好呢?请看下边的内容。


(资料图)

1.前言

2. 架构的定义

在TOGAF企业架构理论中, 架构是从公司战略层面,自顶向下的细化的一部分,从战略 => 业务架构 =>应用/数据/技术架构,当然老板层关注的是战略与业务架构,我们搬砖的需要聚焦到 应用/数据/技术架构 这一层。

3.架构图的分类

系统架构图是为了抽象的表示软件系统的整体轮廓和各个组件之间的相互关系和约束边界,以及软件系统的物理部署和软件系统的演进方向的整体视图。好的架构图可以让干系人理解、遵循架构决策,就需要把架构信息传递出去。

那么,画架构图是为了:解决沟通障碍/达成共识/减少歧义。比较流行的是4+1视图和 C4视图。

3.1 4+1视图

3.1.1 场景视图

3.1.2 逻辑视图

3.1.3 物理视图

用于描述系统软件到物理硬件的映射关系,反映出系统的组件是如何部署到一组可计算机器节点上,用于指导软件系统的部署实施过程。

3.1.4 处理流程视图

5 种架构视图从不同角度表示一个软件系统的不同特征,组合到一起作为架构蓝图描述系统架构。

3.2 C4视图

3.2.1 语境图(System Context Diagram)

3.2.2 容器图(Container Diagram)

3.2.3 组件图(Component Diagram)

4.怎么画好架构图

上面的分类是前人的经验总结,图也是从网上摘来的,那么这些图画的好不好呢?是不是我们要依葫芦画瓢去画这样一些图?

先不去管这些图好不好,我们通过对这些图的分类以及作用,思考了一下。总结下来,我们认为,明确这两点之后,从受众角度来说,一个好的架构图是不需要解释的,它应该是自描述的,并且要具备一致性和足够的准确性,能够与代码相呼应。

4.1 视图的受众

在画出一个好的架构图之前, 首先应该要明确其受众,再想清楚要给他们传递什么信息 ,所以,不要为了画一个物理视图去画物理视图,为了画一个逻辑视图去画逻辑视图,而应该根据受众的不同,传递的信息的不同,用图准确地表达出来,最后的图可能就是在这样一些分类里。那么,画出的图好不好的一个直接标准就是:受众有没有准确接收到想传递的信息。

4.2 视图的元素区分

可以看到架构视图是由方框和线条等元素构成,要利用形状、颜色、线条变化等区分元素的含义,避免混淆。架构是一项复杂的工作,只使用单个图表来表示架构很容易造成莫名其妙的语义混乱。

关注我【一起学嵌入式】,一起学习,一起成长。

觉得文章不错,点击“分享”、“赞”、“在看” 呗!

关键词:

上一篇:

下一篇:

X 关闭

安阳曹操墓将于2022年5月正式对公众开放
时间·2021-12-29    来源·中新网
为什么这次寒潮南方降雪这么明显?
时间·2021-12-29    来源·新华社
山西绛县6名失踪者全部遇难 当地:已立案调查
时间·2021-12-29    来源·中新网

X 关闭