开发者发布 svugy 工具,用 Markdown 绘制软件架构交互式等距图
来源标题:Sketching software architecture with Svugy
开发者推出 svugy,一款用纯 Markdown 文件创建软件架构交互式等距图的工具。该工具受 Simon Brown 的 structurizr 启发,但更强调直接读取用户已有的 Markdown 架构笔记来生成图表。作者认为在 AI 写代码日益普及的当下,清晰的架构视图对引导 AI 智能体尤为重要。
以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。
这篇文章想介绍 svugy——我做的一个工具,用来创建软件架构的交互式等距图,以纯 Markdown 文件编写。
代码库的架构视图一直都很重要,而如今的软件工程师更没有借口忽视它:有了 AI,写代码已经变成一件唾手可得的事,而清晰的架构图景才是让你能引导 agent 不产出垃圾的关键。对于塑造软件架构或理解现有架构这类任务,我总是遵循同一套方法,写在一个 .md 文件里:
结果就是我正在处理的架构的一份 TL;DR,它也成为我想象它、或用现有绘图工具绘制它的基础。
我非常喜欢 Simon Brown 提出的 C4 模型。它不用一张大图,而是从四个抽象层次描述架构:
Simon Brown 还构建了 structurizr,你只需用文本 DSL 描述一次模型,就能得到各个层次的图。它是 svugy 的主要灵感来源,但我想更强调某些诉求:
自然的选择就是让 svugy 直接读取我已经在写的那种文件。一张图就是一个 .md 文件,包含两个部分:## Components 和 ## Edges,也就是我笔记里的那两个列表:
其余规则尽量精简:可选的 frontmatter 用于标题和样式,可选的 description 块用于给任何组件或边附加一些文字说明。
这里有一个 svugy 的小演示,编译成了 wasm:当你在左侧面板输入 markdown 时,svugy 会在右侧渲染 SVG,提供一个可交互的架构
这些是我喜欢使用它的典型工作流:
交互性来自内联在 SVG 中的一个小的运行时,以 <script> 标签形式存在。有些宿主环境(比如 GitHub README)不会运行 SVG 内的脚本:在那里图仍然会显示,只是没有点击交互。
你可以在 gitHub 上浏览代码库,或前往 svugy.dev 查看更多演示和安装命令。在那里你还会找到一个安装提示,可以把安装交给任意你喜欢的 agent 来完成。svugy 本身附带一个 skill,帮助你的 agent 使用它。
正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。