一键 UML 图生成技能
将对象、接口、参与者、状态、数据实体和调用关系整理为适合评审的 Mermaid UML 图。
执行规则
- 第一次渲染前检查
mmdc:command -v mmdc && mmdc --version。 - 未安装时先引导执行
npm install -g @mermaid-js/mermaid-cli,未获明确授权不要代装。 - 本机版本距离 npm 最新版本超过 3 个发布版本时,先询问升级或继续使用旧版本。
- 用户没有指定保存位置时,将
.mmd和导出文件保存到当前项目的docs/mermaid/。 - 渲染失败时区分 Mermaid 语法错误和 Puppeteer 浏览器依赖错误。
- 交付时提供源码、导出文件的绝对路径链接和
mmdc版本。
图表选择
- 类、接口、继承和依赖使用
classDiagram。 - 请求、响应、异步消息和调用顺序使用
sequenceDiagram。 - 生命周期和状态迁移使用
stateDiagram-v2。 - 数据表、字段和基数关系使用
erDiagram。 - 节点文本包含括号、冒号、斜杠或长句时使用引号。
模板
classDiagram
class 用户服务 {
+创建用户()
+查询用户()
}
class 用户仓库 {
+保存()
+查找()
}
用户服务 --> 用户仓库 : 调用
输出要求
先确认参与者或实体边界,再生成中文短标签和关系;保存源码后使用 mmdc 导出 SVG、PNG 或 PDF。默认输出目录不存在时先创建;用户明确指定位置时按用户要求保存。