Mermaid时序图引擎
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_6afd4cd8/mermaid-sequence-diagram-skill。
技能介绍
解决什么问题
工程师在编写接口文档、技术方案或故障复盘时,常需要描述用户、服务、数据库之间的交互顺序。手动绘制时序图不仅耗时,还容易出现图表与代码逻辑不一致的问题,格式也难以统一。Mermaid 时序图生成技能正是为了解决这类痛点,让开发者能从自然语言的交互描述直接生成可渲染的 Mermaid 时序图代码。
核心能力与工作方式
该技能的核心是将用户的交互流程描述转化为结构化的 Mermaid 时序图代码。它首先会解析用户需求,明确参与者、消息类型(同步、异步、回复)以及控制流逻辑(循环、条件、并行、异常)。随后,技能会根据场景选择合适的语法:
- 参与者管理:支持
participant显式声明、actor角色符号,以及boundary、control、database等7种参与者类型,通过@{ "type": "..." }语法即可指定,让图表语义更清晰。 - 消息与箭头:提供标准箭头(如
->>带箭头实线、-->虚线)和半箭头类型,还可通过+/-后缀快速标记激活/停用状态,直观展示方法调用的生命周期。 - 控制流结构:支持
loop循环、alt条件分支、opt可选路径、parallel并行等结构,能清晰表达复杂业务流程。 - 样式与配置:可通过
box分组、rect背景高亮,或%%{init}%%指令调整字体、对齐等样式参数,满足不同文档的排版需求。
最后,技能会将生成的代码包裹在```mermaid```代码块中,并验证参与者是否完整、结构是否闭合、箭头方向是否正确,确保代码可直接渲染。
注意点与适用边界
使用该技能时需留意几个细节:
end关键字可能破坏图表解析,若必须使用,需用(end)、[end]或{end}包裹。box的#hex颜色不被支持,需改用rgb()、hsl()等格式。create只能创建消息的接收者,无法创建发送者。- 消息文本中的分号需编码为
#59;,否则可能导致语法错误。
该技能适用于需要快速生成标准化时序图的开发场景,尤其适合配合文档或代码注释使用,但它更适合描述结构化的交互流程,不适合过于抽象的模型或无明确时序的复杂逻辑。
使用场景
- 评审微服务调用链时,需要把用户、服务、数据库之间的同步与异步消息画成时序图。
- 编写接口文档时,要把客户端请求、服务端处理和数据库查询的调用顺序生成 Mermaid 图。
- 排查跨系统故障时,需要用激活标记展示方法调用生命周期,并标注循环、条件分支。
- 给架构方案做说明时,需要用 participant 类型和 Box 分组表达边界、控制与数据实体。
适合人员
- 后端工程师:需要把接口调用和跨服务交互快速画成 Mermaid 时序图并写入文档。
- 架构师:需要在设计评审中用 participant 类型和控制流结构表达复杂系统边界。
- 技术文档作者:需要把交互流程描述转成可直接渲染的 Mermaid 代码,减少手工绘图。
- SRE 与排查人员:需要用激活、循环和分支标记还原调用路径,定位超时或失败原因。