Agent Skills
返回列表
一键UML图生成

一键UML图生成

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_adbca5d8/one-click-uml。

技能介绍

解决什么问题

评审设计文档时,最头疼的不是"图不会画",而是图散落在各处:类关系写在接口文档里,时序逻辑躺在聊天记录里,状态迁移藏在需求描述中。评审者得自己在脑子里把这些信息拼成一张图,理解成本高,还容易漏掉边界情况。这个技能的目标,是把已经存在的结构化描述(对象、接口、参与者、状态、数据实体、调用关系)直接整理成适合评审的 Mermaid UML 图,让图跟着项目代码一起放进 docs 目录,而不是事后补画。

它如何工作

图表类型是显式规则,不是自由发挥:

  • 类、接口、继承和依赖关系走 classDiagram
  • 请求、响应、异步消息和调用顺序走 sequenceDiagram
  • 生命周期和状态迁移走 stateDiagram-v2
  • 数据表、字段和基数关系走 erDiagram

渲染前的检查流程:

  • 首次渲染前,先用 command -v mmdc && mmdc --version 确认 Mermaid CLI 是否可用
  • 本机没有安装时,技能会引导你通过 npm 全局安装 Mermaid CLI,但未获明确授权不会代装
  • 本机版本距离 npm 最新版超过 3 个发布版本时,先询问是升级还是继续用旧版本

生成与交付流程:

  • 先确认参与者或实体边界,再生成中文短标签和关系描述
  • 保存 .mmd 源码后,用 mmdc 导出 SVG、PNG 或 PDF
  • 用户没有指定位置时,源码和导出文件统一存入当前项目的 docs/mermaid/ 目录,默认目录不存在时先创建
  • 渲染失败时区分 Mermaid 语法错误和 Puppeteer 浏览器依赖错误,避免把环境问题误报成语法问题

交付物包括源码、导出文件的绝对路径链接和当前 mmdc 版本号,评审者可以直接点开原图并复现渲染结果。

适用边界与注意点

  • 它不负责凭空"发明"架构,输入描述越结构化,输出图越准确
  • 它不替代领域建模的判断,只负责把已有的实体和关系转成规范的图
  • 节点文本包含括号、冒号、斜杠或长句时,技能会自动加引号处理,防止 Mermaid 解析失败
  • 导出依赖 Puppeteer,在无浏览器依赖的环境(如精简容器)中可能渲染失败,需要提前确认环境

使用场景

  • 接口评审前,把类、接口、继承与依赖关系整理成 Mermaid 类图,导出 SVG 放进评审文档
  • 梳理微服务间请求、响应与异步消息的调用顺序,生成 Mermaid 时序图供评审讨论
  • 状态机需求评审时,把对象生命周期和状态迁移画成 Mermaid 状态图,标注迁移条件
  • 数据库设计评审时,用 ER 图展示数据表、字段和基数关系,源码存入 docs/mermaid 目录

适合人员

  • 后端开发工程师:评审前要把类间依赖和继承关系画成规范类图,避免口述遗漏
  • 架构师或技术负责人:评审时需要序列图、状态图等可直接放进文档并复现渲染的图
  • 数据库开发或 DBA:设计评审需要 ER 图清晰展示表结构、字段与基数关系
  • 技术评审组织者或文档维护人:评审材料需要 .mmd 源码和导出图,保证结果可复现