Mermaid 绘图引擎
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @kunlungrowth/mermaidjs-v11。
技能介绍
先解决文档图难维护的问题
架构图、API 流程、数据库 schema、项目时间线如果散落在截图或设计工具里,改一次就要重新画一遍,评审时也难判断差异。这个技能的价值在于把图还原成 可版本化文本:你用声明式语法描述结构和流向,Mermaid.js v11 负责布局与渲染。
核心能力与工作流
- 选图型:从
flowchart、sequenceDiagram、classDiagram、stateDiagram、erDiagram、gantt、journey等 24+ 种类型中匹配目标;复杂图可拆分后分别表达。 - 写源码:节点用
A[文字],判断用B{条件},连接用-->或-->|标签|,注释以%%开头。输出会整理成DiagramSpec,包含图型、完整 Mermaid 源码和渲染目标。 - 内联渲染:在 Markdown 代码块前加
---theme: dark---可控制主题;也可使用look: handDrawn、securityLevel等配置。 - 导出与嵌入:生成的图可渲染为 SVG、PNG、PDF,或通过引入 Mermaid 脚本在网页中直接加载。下游可交给文档生成、演示或前端项目消费。
适用边界
它适合需要 diff、评审和自动化生成的工程文档,不适合像素级精修的平面设计。超大图容易损失可读性,建议先拆分再组合;若安全模型特殊,需要明确限制交互能力。
使用场景
- 在技术设计文档中绘制系统架构与服务依赖图,便于评审时直接对文本做 diff 和修改
- 为 API 接口文档补充时序图,展示浏览器、前端、后端、数据库之间的调用顺序
- 在 README 中用甘特图呈现项目里程碑与排期,并随 Markdown 一起提交版本库
- 需要把 ER 图导出为 SVG 或 PNG 插入 PPT,向团队讲解数据库表关系
适合人员
- 后端工程师,需要在技术方案与评审文档中给出清晰架构图和接口时序图
- 技术文档作者,要把流程、状态机和库表结构以文本形式沉淀进可版本化文档
- 前端工程师,负责完善 README 的可视化说明并在网页中直接渲染 Mermaid 图
- 数据工程师或 DBA,需要为数仓建模补充 ER 图并导出图片用于评审汇报