业务角色交互与时序图生成
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_fccf428b/mermaid-sequence-diagram-creator。
技能介绍
时序图写作的两个隐藏成本
手写 Mermaid 时序图有两个容易被低估的坑。一是语法细节:participant 定义、-> 与 --> 的消息方向、activate/deactivate 的配对,任何一处写法不对,整张图就渲染失败。二是文档维护成本:当一个业务流程横跨用户、订单服务、支付网关、消息队列等角色时,把脑中的交互顺序翻译成可渲染的代码本身就要花不少时间。
这个技能瞄准的就是这个中间环节:
- 语法兜底:Mermaid sequence diagram 的规范写法、嵌套激活块、注释放置位置
- 结构化引导:不是直接丢模板,而是先帮你枚举角色与消息顺序
- 输出校验:生成结果按通用标准检查,减少渲染失败
工作方式与核心步骤
按 SKILL.md 的设计,它分四步推进:
- 识别意图——你提到 "mermaid sequence diagram creator" 或咨询相关最佳实践时自动激活
- 逐步引导——按步骤给出建议,而非一次性吐出全部内容
- 生成代码——输出可直接嵌入文档的 Mermaid 源码与配置
- 校验结果——对照常用标准验证输出是否合法
典型输入是一段业务流程描述或角色清单。它先与你对齐角色数量与消息时序,再产出对应的 sequenceDiagram 块。
适用边界与注意点
- 属于 design-media(Visual Content)分类,聚焦图表内容,不做通用文档排版
- 前提是环境就绪:依赖工具已安装、服务访问权限已授予,否则会触发
Tool not found或Permission denied - 生成结果仍需人工复核:跨团队的业务流程中,机器对领域语义的理解有限
- 遇到
Configuration invalid时,按文档补齐必填参数即可
使用场景
- 撰写技术设计文档时,需要把前端、后端与第三方支付网关之间的请求流转画成 Mermaid 时序图。
- 更新接口文档时,要把客户端、服务端与数据库之间的调用顺序写清楚,方便调用方对接。
- 整理客服工单流转流程,需绘制用户、客服系统与运维值班三角色的消息交互时序。
- 为开源项目编写 README,想把本地开发时的安装、启动与数据持久化调用顺序用图表记录下来。
适合人员
- 后端工程师:写接口文档时需要把调用顺序画清楚,但不想反复调试 Mermaid 语法。
- 技术文档工程师:把架构评审会上的口头描述整理成可渲染的交互图放进文档。
- 项目协调人:汇报跨部门流程时需要一张能直接放进 PPT 的角色消息时序图。
- 开源仓库维护者:README 中想加入时序图说明本地开发流程,但不精通图表语法。