DEV Community

cognitalk
cognitalk

Posted on

Diagrams as Code with AI with Jacqui Read


https://www.youtube.com/watch?v=QvESyTxeN4o

驾驭AI绘图:从“图即代码”工具选择到“规范驱动开发”的实践指南


通俗解释全文

这篇采访的核心内容是关于如何利用AI(特别是大语言模型)来帮助我们画软件架构图。可以把这想象成:

  • 以前画图:就像你用Word或画图软件手动画流程图,改一个小地方就得重新调整布局,很麻烦,而且不同人画的风格不统一。
  • 现在“图即代码”:就像你用一种特殊的编程语言(比如PlantUML、Mermaid)来描述你想画的图。你写几行代码,系统就自动生成一张漂亮的图。好处是修改方便(改一行字就行)、可以和代码一起管理、还能像看代码差异一样看图的版本变化。
  • 引入AI助手:现在,你可以让AI帮你写这些“画图代码”。但关键是,你不能完全依赖它。AI可能会胡编乱造一些不存在的语法(这叫“幻觉”),或者不理解复杂的布局要求。所以,你需要自己懂一点“画图语言”的基础,才能判断AI给出的结果对不对,并且能用精确的语言指挥它。

简单来说,这篇文章教你:如何使用AI这把“瑞士军刀”来高效、准确地完成“图即代码”的工作,同时警惕它的“幻觉”陷阱,并把它融入到更先进的“规范驱动开发”流程中。


详细分段与要点

第一部分:开场介绍与嘉宾背景 (0% - 5%)

  1. 节目开场与致谢:主持人开场,欢迎观众收听新一期播客节目,并对本次活动的组织者“Software Architecture Gathering”表示感谢。
  2. 嘉宾介绍:
    • 嘉宾是Jacqui Read,她曾作为嘉宾参与过本节目,当时谈论的是她的著作《Communication Patterns》。
    • Jacqui近期专注于研究如何将“图即代码”与AI结合,并开始涉足“规范驱动开发”领域。
  3. 主持人补充:另一位主持人也做了简短自我介绍,并点明了Jacqui是“图即代码”领域的专家,这也是邀请她的原因。
  4. 引出核心话题:主持人提到Jacqui昨天刚举办了一场关于“借助AI实现图即代码”的研讨会,并直接提问:AI是如何融入“图即代码”的?其价值在哪里?

第二部分:AI如何融入“图即代码”及三大主流工具对比 (5% - 25%)

  1. AI的角色定位:
    • AI(大语言模型)确实有用,但不能盲目依赖。很多人想用AI解决一切问题,但在绘图这件事上,需要一个有技能的人类来主导。
    • AI可以帮你创建或更新PlantUML、Mermaid或Structurizer的图表代码,但你必须有足够的知识去判断输出的质量,并能提出正确的问题。
    • 关键问题:如果问得太笼统,AI很容易产生“幻觉”,编造出错误的语法或元素。
  2. 三大“图即代码”工具详解:
    • PlantUML:
      • 最流行的工具之一,最初专为UML图设计,现在也支持其他多种图表类型。
      • 缺点:基于Java构建,导致在某些Web环境(如GitHub)中渲染不如其他工具方便。
    • Mermaid:
      • 基于JavaScript,因此在互联网上的各种平台(如Markdown编辑器、GitHub)中更容易被渲染和支持。
      • 缺点:目前不支持C4模型图,效果不佳。
    • Structurizer:
      • 专为C4模型设计,与其他工具有本质区别。
      • 核心优势:拥有一个模型(Model)在背后支撑。你创建一个模型后,可以从中生成多个不同的视图(View)。
      • 维护性极佳:当你添加一个新服务或更改某个名称时,只需修改模型,所有相关的视图都会自动更新。甚至可以导出为PlantUML等其他格式。
  3. “画图”与“建模”的本质区别:
    • 主持人指出,使用PlantUML和Mermaid只是在“画图”,而Structurizer因为背后有模型,所以是在“建模”。
    • “图即代码”相比传统拖拽式绘图软件(如Draw.io、Visio)的优势在于:它是纯文本,易于维护、可以放在代码仓库中进行版本控制,并且能够通过diff功能清晰地看到每次改动。

第三部分:AI的实际应用技巧与挑战 (25% - 40%)

  1. AI的具体用途:
    • 格式转换:例如,将已有的PlantUML代码转换为Mermaid代码。
    • 批量迁移:如果你有几十个PlantUML或Mermaid的C4图,可以让AI帮你创建一个Structurizer工作区,这是一个巨大的效率提升点。
  2. 应对“幻觉”的策略:
    • 案例说明:Jacqui举例,如果你让AI把一个活动图中的元素从左移到右,它可能会编造出一些根本不存在的奇怪箭头语法。
    • 解决方案:你必须具备专业知识,用非常具体、精确的语言下达指令。例如,不要说“把这个移过去”,而是说“重新排列元素,使这两个项目出现在右侧”。
  3. 选择工具的更多考量因素:
    • 图表类型需求:是否需要特定的图,如序列图、活动图(PlantUML支持)、泳道图(Sankey Diagram)?
    • 组织现状:团队已经熟悉哪种工具?是否与现有的知识管理系统(如支持Mermaid渲染的Markdown编辑器)兼容?
    • 许可证限制:所有工具都是开源的,但许可证不同,公司可能有政策限制使用某些许可证的软件。
  4. 必备技能培养:
    • 理解各工具优劣:学员应学会评估,回到公司后能判断哪个工具最适合自己的特定情况。
    • 知道何时用AI,何时不用:有时自己手写代码比给AI写一个长长的提示词更快。例如,创建一个简单的序列图,手写可能比描述给AI听更省事。
    • 识别AI的错误:能一眼看出AI生成的代码中有哪些是“幻觉”。

第四部分:C4模型与行为图的重要性 (40% - 60%)

  1. C4模型的层次:
    • Landscape(景观层):展示组织内所有系统及其相互关系。
    • Context(上下文层):聚焦于我们关心的特定系统及其与外部系统的交互。
    • Container(容器层):将系统分解为独立可部署的单元(如微服务、数据库)。
    • Component(组件层):进一步细化容器内部的模块。
    • Code(代码层):最底层,通常用UML类图表示,变化最快,不建议手动维护。
  2. 为何需要行为图:
    • C4主要展示结构,而系统真正的价值体现在行为上——用户关心的是系统能不能做他们想要的事,而不关心内部结构。
    • 因此,除了C4,还需要活动图、序列图等来描述动态行为。
  3. 图例(Legend)的重要性:
    • 一个好的图表必须有图例,否则读者无法理解图中的符号含义。
    • 工具对比:
      • Mermaid:完全不支持图例,这是个重大缺陷。
      • PlantUML:支持图例,但定义起来比较麻烦。
      • Structurizer:会自动根据模型和图表的样式生成精准的图例,体验最好。
  4. 关于颜色与无障碍:
    • 传统的C4蓝灰色配色方案对于色盲人士可能不够友好。Simon Brown(C4创始人)也鼓励大家使用自定义颜色方案。
    • Structurizer现在会随机分配主题,并允许用户像CSS一样自定义样式,增强了灵活性。

第五部分:AI的局限性、模型选择与“规范驱动开发” (60% - 85%)

  1. AI是可选而非必需:
    • 再次强调,使用AI是可选的。在研讨会的练习环节,学员可以选择用AI辅助,也可以选择手写代码。
    • 有时,为了得到一个理想的结果,你写给AI的提示词长度可能超过了你手写代码的长度。
  2. 模型的选择与局限性:
    • 常用模型:Jacqui最近开始更多地使用Claude,认为它在很多方面至少和ChatGPT一样好。
    • 模型并非完美:即使是最好的模型也会出错。例如,它可能无法识别一个故意放入的错误代码,甚至会把无意义的字符解释成颜色代码。
    • 版本迭代问题:AI的训练数据有截止日期,可能不知道最新的DSL语法(如处于Beta版的新功能)。因此,了解基础知识至关重要。
    • 非确定性:同一个模型在不同时间执行相同的任务,结果也可能不同,就像考试状态有好有坏。
  3. “规范驱动开发”:
    • 概念:这是一种新兴的开发模式。开发者不再直接写代码,而是编写一份包含架构决策、原则和需求的“规范”(Specification),然后让AI根据这份规范来生成代码。
    • 与“氛围编码”的区别:“氛围编码”是直接把问题丢给AI,让它全权负责。“规范驱动开发”则强调人类管理上下文,确保AI遵循既定的规范和架构决策。
    • “为什么”的重要性:架构文档必须包含做出决策的“为什么”(Why),因为“怎么做”(How)和“做了什么”(What)可以从“为什么”推导出来,反之则不行。
  4. “图即代码”在规范驱动开发中的角色:
    • 作为输出:AI可以根据规范生成“图即代码”,作为验证和理解的手段。
    • 作为输入:人类可以将已有的图表作为上下文提供给AI,帮助它更好地理解系统。
    • ASCII图的妙用:AI可以在Markdown中直接生成ASCII艺术图,这在命令行或纯文本环境中非常有用,可以作为快速验证和沟通的工具。
    • 当前工具的不足:目前的“规范驱动开发”工具大多偏向“瀑布流”思维,假设初始规范是正确的,难以进行敏捷迭代,且普遍忽略了“图即代码”这一重要输入。

第六部分:信任危机、验证方法与未来展望 (85% - 100%)

  1. 对AI的过度信任问题:
    • 主持人指出,人们往往对AI有过度的信心,而AI的设计本身就在诱导我们信任它(例如,它从不承认“我不知道”)。
    • 根本原因:大语言模型本质上只是一个“猜下一个词”的游戏,它被训练成要给出一个答案,而不是承认无知。
  2. 如何验证AI生成的结果:
    • 多模型交叉验证:用一个模型生成代码,再用另一个模型或代理(Agent)去审查,检查规范和代码是否匹配。
    • 从代码生成图表:与其相信AI根据规范生成的图,不如让它根据实际代码生成图表,这样更接近真实情况。
    • 架构适应度函数:使用自动化测试(适应度函数)来持续验证代码是否符合架构规范。
  3. 关于布局的痛点:
    • 自动布局算法有时会产生混乱的线条交叉。虽然工具提供了一些控制手段(如指定方向、调整元素顺序),但很难做到完美。
    • Structurizer提供了“手动布局”功能,但缺点是当模型改变时,手动布局可能需要全部重做。
  4. 总结与告别:
    • 主持人对Jacqui的精彩分享表示感谢。
    • 预告了当晚的活动:一场关于“AI对软件架构影响”的现场直播讨论。
    • 再次感谢会议主办方和听众。

Top comments (0)