【架构治理工具】在代码存储库中记录软件架构

news2024/11/16 14:22:29

Markdown 是一种标准的简单语法，用于创建具有专业外观的文档。它比 HTML 更简单，无需专门的编写编辑器即可进行管理。Git配置管理工具也支持markdown格式。在 Git 环境中，markdown 一般用于项目的简单介绍和构建说明。（自述文件）。本文介绍了如何将 Markdown 格式与模板一起用于架构文档。

5cc6bec57acc656352c9952d16770374.png

带有 Markdown 的架构文档


与代码一起管理软件的架构设计和设计决策将为项目提供极大的便利。当我们的设计与代码一起保存在配置管理环境中时，我们可以一起进行设计变更和代码变更。当新工程师开始项目并将代码拉到他的计算机上时，他有机会看到系统的架构。


准备 Markdown 文档 IDE


您可以使用 Visual Studio Code 和类似的 IDE 与您的代码一起准备 markdown 文档。（市场上有 markdown 编辑器，但使用 IDE 来做会更实用）。您可以在 Visual Studio Code 中使用“Markdown Preview Enhanced”插件。使用这个插件，你可以在 VS Code (Preview) 中直观地看到 markdown 文档。您还可以使用相同的工具生成 HTML、World 或 PDF 文档。

dc4195cf97c12d05500832e487073926.png

MD Document Preparation with VS Code

UML 和 C4 图


您可以将使用 Plant UML 脚本语言绘制的 UML 和 C4 图放入 Markdown 文档中。这样，您可以将整个设计（包括绘图）保存在一个地方。您放入 Markdown 文档中的 UML 和 C4 图可以在预览窗口中看到。（带有一个名为“PlantUML”的插件）。此外，当您导出 pdf 或 html 时，您将能够将这些图表视为图形。GIT 工具具有可视化显示在此 PlantUML 中编写的设计脚本的功能。通过这种方式，可以看到带有 Bitbucket 的设计（具有适当的版本和配置）。此功能在开源 Github 站点上尚不可用。

570a4ff0bbf2e251106bebe384c0ee3f.png

  • Adding a C4 Component Diagram to a Markdown document

如果git服务器不支持可视化，可以先从plantuml服务器站点制作一张png或svg的图，然后将相关的图发送到Git服务器。然后你可以在markdown文档中将此图作为绘图链接。您可以在使用其他工具制作的图纸中使用此方法。

Arch 42 模板


Arc 42 是架构文档的模板。通过正确完成此 Arc42 模板，您将在一个地方拥有软件架构和设计的关键设计决策。

  1.  — 简介和目标

  2.  — 约束

  3.  - 背景和范围

  4.  — 解决方案策略

  5.  - 构建块视图

  6.  — 运行时视图

  7.  — 部署视图

  8.  — 交叉切割概念

  9.  — 架构决策

  10.  - 质量属性

  11.  — 风险和技术债务

您可以在 Arch42 网站上访问 markdown 模板。相关网站上有一个草稿作为单个文件或作为每个部分的单独文件。


您可以在此模板中使用 C4 模型和 UML 图。例如，我们可以使用第 3 章中的 C4 范围图，第 5 章中的容器图和组件图。第 6 章中可以使用 C4 动态图或 UML 序列图。部署图可以使用 C4 或 UML 符号在第 7 章。
对于第 10 章，我们可以使用为架构权衡分析方法 (ATAM) 准备的表格。在这种情况下，您可以访问和使用我准备的降价表草稿。

d01e8037b667c95d8039f3cdbf73d556.png

结论


建议使用 Arch 42 模板以 Markdown 格式准备软件架构文档，并在代码中包含 Git 结构中的 C4 模型和 UML 图。该解决方案提供了高质量、可管理、版本控制和可追溯的架构文档。

本文 :https://architect.pub/documenting-software-architecture-code-repository
讨论：知识星球【首席架构师圈】或者加微信小号【ca_cto】或者加QQ群【792862318】
公众号

【jiagoushipro】
【超级架构师】
精彩图文详解架构方法论，架构实践，技术原理，技术趋势。
我们在等你，赶快扫描关注吧。		6522a8e9cc27904a1085629a61f6c134.jpeg
微信小号

【ca_cea】
50000人社区，讨论：企业架构，云计算，大数据，数据科学，物联网，人工智能，安全，全栈开发，DevOps，数字化.

57cb13f2aa27bb95e9262416aaa1d27b.jpeg

QQ群

【285069459】深度交流企业架构，业务架构，应用架构，数据架构，技术架构，集成架构，安全架构。以及大数据，云计算，物联网，人工智能等各种新兴技术。
加QQ群，有珍贵的报告和干货资料分享。

34b125bce80f926006d78072075ff736.jpeg

视频号【超级架构师】
1分钟快速了解架构相关的基本概念，模型，方法，经验。
每天1分钟，架构心中熟。

6a2173129c3445de06a4f240ea0e96a4.jpeg

知识星球【首席架构师圈】向大咖提问，近距离接触，或者获得私密资料分享。

ba3533bd1476dd085d4a2d58c82f12bd.jpeg

喜马拉雅【超级架构师】路上或者车上了解最新黑科技资讯，架构心得。【智能时刻，架构君和你聊黑科技】
知识星球认识更多朋友，职场和技术闲聊。知识星球【职场和技术】
领英Harryhttps://www.linkedin.com/in/architect-harry/
领英群组领英架构群组
https://www.linkedin.com/groups/14209750/
微博‍‍【超级架构师】智能时刻‍
哔哩哔哩【超级架构师】

14cb96fca3ca50b734b11bd0e6e523e0.jpeg

抖音【cea_cio】超级架构师

7f9b3afb5d10c1dc188acf5f235151ef.jpeg

快手【cea_cio_cto】超级架构师

02376b53ba30bbff82e01e16ef405add.jpeg

小红书【cea_csa_cto】超级架构师

89aa3338043a8bebdeb28a468e366e8e.jpeg

网站CIO(首席信息官)https://cio.ceo
网站CIO,CTO和CDOhttps://cioctocdo.com
网站架构师实战分享https://architect.pub   
网站程序员云开发分享https://pgmr.cloud
网站首席架构师社区https://jiagoushi.pro
网站应用开发和开发平台https://apaas.dev
网站开发信息网https://xinxi.dev
网站超级架构师https://jiagou.dev
网站企业技术培训https://peixun.dev
网站程序员宝典https://pgmr.pub    
网站开发者闲谈https://blog.developer.chat
网站CPO宝典https://cpo.work
网站首席安全官https://cso.pub    ‍
网站CIO酷https://cio.cool
网站CDO信息https://cdo.fyi
网站CXO信息https://cxo.pub

谢谢大家关注，转发，点赞和点在看。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/689942.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

CSS 渐变

CSS 渐变

CSS 渐变 01 CSS 渐变基础 颜色的几种表示 渐变的几种方式 02 特殊的渐变举例 水平渐变 垂直渐变（矩形四个点三种颜色） 线性渐变只能在一个方向上渐变，要想实现这种渐变，可以使用两个标签进行叠加：一个负责水平…
阅读更多...
npm运行没反应的问题

npm运行没反应的问题

npm 遇到的问题 我们在经常切换node版的时候会遇到npm命令失效的问题。 我们不管运行npm的什么命令都是一闪然后就没有任何输出，效果如下： 主要原因是因为npm config set prefix 改包的路径出问题了 解决方法是：打开系统盘找到下列目录&am…
阅读更多...
水力发电在可再生能源中的地位和潜力

水力发电在可再生能源中的地位和潜力

可再生能源的发展已成为全球能源领域的重要趋势，而作为最古老、最成熟的可再生能源形式之一，水力发电在能源供应和环境保护方面发挥着重要作用。本文将深入探讨水力发电在可再生能源中的地位和潜力，包括其技术特点、发展趋势以及面临的挑战和…
阅读更多...
多线程/std::thread线程退出方式详解

多线程/std::thread线程退出方式详解

文章目录 概述不 join 也不 detach执行了detach并不能万事大吉建议使用 join 函数 概述 这里默认你已经了解 std::thread 类的基本使用，和WinAPI多线程编程中 “如何优雅的退出线程” 等相关知识。阅读该文前，建议先看看《多线程 /C 11 std::thread 类深…
阅读更多...
考场作弊行为自动抓拍告警算法 yolov7

考场作弊行为自动抓拍告警算法 yolov7

考场作弊行为自动抓拍告警系统通过yolov7python网络模型算法，考场作弊行为自动抓拍告警算法实时监测考场内所有考生的行为，对考生的行为进行自动抓拍，并分析判断是否存在作弊行为。YOLOv7 的发展方向与当前主流的实时目标检测器不同&#xff…
阅读更多...
ChatGLM2本地部署的实战方案

ChatGLM2本地部署的实战方案

大家好，我是herosunly。985院校硕士毕业，现担任算法研究员一职，热衷于机器学习算法研究与应用。曾获得阿里云天池比赛第一名，CCF比赛第二名，科大讯飞比赛第三名。拥有多项发明专利。对机器学习和深度学习拥有自己独到的见解。曾经辅导过若干个非计算机专业的学生进入到算法…
阅读更多...
PHP wangEditor插件打包（包含公式、上传附件）完整版

PHP wangEditor插件打包（包含公式、上传附件）完整版

注意&#xff1a;js,css文件引用路径需要修改 先看效果 index.html文件 <!-- 新版编辑器 --> <script type"text/javascript" src"js/editor/dist/index.js"></script> <link href"js/editor/dist/css/style.css" rel&qu…
阅读更多...
Mysql_5.7下载及安装（CentOS7）

Mysql_5.7下载及安装（CentOS7）

文章目录 安装MySQL的几种方式一、 使用docker安装MySQL1.1 卸载旧版本&#xff08;如果存在docker&#xff0c;需先卸载旧版本&#xff09;1.2 安装Docker使用存储库安装(推荐使用) 1.3 安装mysql5.7.35(普通用户下)*** 安装MySQL:5.7.35镜像*** 进入容器中查看配置文件以及数…
阅读更多...
Vue----Vue条件渲染

Vue----Vue条件渲染

【原文链接】Vue----Vue条件渲染 &#xff08;1&#xff09;在components文件夹下新建一个Ifdemo.vue文件。 &#xff08;2&#xff09;然后在文件中编写如下内容&#xff0c;即写入一个标题 <template><h3>条件渲染</h3> </template> <script&…
阅读更多...
Go语言开发者的Apache Arrow使用指南：数据类型

Go语言开发者的Apache Arrow使用指南：数据类型

如果你不是做大数据分析的&#xff0c;提到Arrow这个词&#xff0c;你可能会以为我要聊聊那个箭牌卫浴或是箭牌口香糖(注&#xff1a;其实箭牌口香糖使用的单词并非Arrow)。其实我要聊的是Apache的一个顶级项目&#xff1a;Arrow[1]。 为什么要聊这个项目呢&#xff1f;说来话长…
阅读更多...
【吴恩达deeplearning.ai】基于ChatGPT API打造应用系统（上）

【吴恩达deeplearning.ai】基于ChatGPT API打造应用系统（上）

以下内容均整理来自deeplearning.ai的同名课程 Location 课程访问地址 DLAI - Learning Platform Beta (deeplearning.ai) 一、大语言模型基础知识 本篇内容将围绕api接口的调用、token的介绍、定义角色场景 调用api接口 import os import openai import tiktoken from dote…
阅读更多...
使用 MediaPipe 身体跟踪构建不良身体姿势检测和警报系统

使用 MediaPipe 身体跟踪构建不良身体姿势检测和警报系统

文末附实现相关源代码下载链接 正确的身体姿势是一个人整体健康的关键。然而，保持正确的身体姿势可能很困难，因为我们经常忘记这一点。这篇博文将引导您完成为此构建解决方案所需的步骤。最近，我们在使用 MediaPipe POSE 进行身体姿势检测方面玩得很开心。 使用 MediaPipe P…
阅读更多...
axios.create()方法中的baseURL是什么意思

axios.create()方法中的baseURL是什么意思

阅读更多...
el-form复杂表单嵌套el-table实现复制字段并校验删除等功能

el-form复杂表单嵌套el-table实现复制字段并校验删除等功能

功能&#xff1a;表单项全部复制&#xff0c;表单项根据el-table选择后复制部分内容&#xff0c;做所有表单项的校验&#xff0c;部分表单项删除功能 点击添加饮品爱好后弹出el-table表单 选择好后点确定如下图&#xff0c;并且实现删除功能&#xff0c;删除仅仅删除饮品和爱好…
阅读更多...
Excel 插入对象选PDF文件后，跳出图像数据不充分对话框，怎么解决

Excel 插入对象选PDF文件后，跳出图像数据不充分对话框，怎么解决

环境&#xff1a; excel 2021 Win10 专业版 问题描述&#xff1a; Excel 插入对象选PDF文件后&#xff0c;跳出图像数据不充分对话框 解决方案&#xff1a; 1.打开文件-选项-高级-不压缩文件中的图像&#xff0c;前面打勾 2.重启excel&#xff0c;再此插入解决&#xf…
阅读更多...
Kears-4-深度学习用于计算机视觉-使用预训练的卷积网络

Kears-4-深度学习用于计算机视觉-使用预训练的卷积网络

0. 说明&#xff1a; 本篇学习记录主要包括&#xff1a;《Python深度学习》的第5章&#xff08;深度学习用于计算机视觉&#xff09;的第3节&#xff08;使用预训练的卷积神经网络&#xff09;内容。 相关知识点&#xff1a; 预训练模型的复用方法&#xff1b;预训练网络 (p…
阅读更多...
ResNet网络结构

ResNet网络结构

Deep Residual Learning for Image Recognition 论文&#xff1a;https://arxiv.org/abs/1512.03385 代码&#xff1a;ResNet网络详解及Pytorch代码实现&#xff08;超详细帮助你掌握ResNet原理及实现&#xff09;_basic block结构图_武晨的博客-CSDN博客 【DL系列】ResNet网…
阅读更多...
前端Vue自定义签到积分获取弹框抽取红包弹框 自定义弹框内容 弹框顶部logo

前端Vue自定义签到积分获取弹框抽取红包弹框 自定义弹框内容 弹框顶部logo

前端Vue自定义签到积分获取弹框抽取红包弹框 自定义弹框内容 弹框顶部logo&#xff0c; 下载完整代码请访问uni-app插件市场地址&#xff1a;https://ext.dcloud.net.cn/plugin?id13204 效果图如下&#xff1a; # cc-downloadDialog #### 使用方法 使用方法 <!-- show&…
阅读更多...
用VSCode开发的Vue项目请求HBuilder项目的JSON数据

用VSCode开发的Vue项目请求HBuilder项目的JSON数据

在学Vue之前采用HBuilder学习了HTML,CSS.JavaScript&#xff0c;jQuery&#xff0c;AJAX&#xff0c;最方便的就是可以请求项目中的JSON数据&#xff0c;当然也可以请求【聚合数据】的数据。 现在用VSCode开发&#xff0c;去访问HBuilder发布的项目中的json数据&#xff0c;因…
阅读更多...
chatgpt赋能python：Python计算器程序代码：一种简单却强大的工具

chatgpt赋能python：Python计算器程序代码：一种简单却强大的工具

Python计算器程序代码&#xff1a;一种简单却强大的工具 如果你是一名计算机编程爱好者&#xff0c;那你一定不会陌生于Python编程语言。Python是如今最受欢迎的编程语言之一&#xff0c;它简单易学、功能强大&#xff0c;也有着庞大的社区支持&#xff0c;使得它成为了很多人…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023