↑

Mermaid 架构绘图与设计文档助手v1.0.0

design-doc-mermaid7 KB

根据文字说明或源码生成 Mermaid 活动图、部署图、架构图与时序图,并可按模板编写架构、API、数据库等设计文档。用户提出“画流程或架构图”“代码转图”“生成设计文档”,或需要提取校验 Mermaid、批量导出 PNG/SVG 时使用。

Mermaid 架构绘图设计文档助手
0 0 0 0 更新于 2026-11-04 18:37

免责声明:本站部分 Skill 来源于公开渠道,使用前请注意识别相关风险,内容版权归原作者所有,如 Skill 涉及版权问题,请在线反馈,核实后予以下架处理。

概述

面向需要从文字说明或源码梳理系统结构、业务流程和服务交互的研发与技术文档场景。它按需求选择活动图、部署图、架构图或时序图路径,生成 Mermaid 图源,并给出 Spring Boot、FastAPI、React 等代码库的反向成图方法。还可组合架构、API、功能、数据库和系统设计模板输出图文文档,配合语法校验、Unicode 语义符号、故障恢复及 PNG/SVG 转换,交付可嵌入 Markdown 的 .mmd 与图像文件。

技能包含

技能包根目录 /├── SKILL.md        # (本文件)技能主说明:图表选型、代码转图、设计文档及校验导出流程└── metadata.json   # 技能包元数据配置

核心能力

  • 多类型图表生成:将业务流程、基础设施、系统组件或 API 交互描述分别转化为活动图、部署图、架构图和时序图。
  • 代码反向成图:按代码转图工作流分析 Spring Boot、FastAPI、React、Python ETL、Node/Express 和 Java Web 项目,提炼组件层级、调用链、数据流与部署关系。
  • 设计文档编排:提供架构、API、功能、数据库和完整系统五类设计模板的选择路径,把文字说明与相关 Mermaid 图组合成设计文档。
  • 校验后发布:按统一命名保存 .mmd 和图像,使用 mmdc 校验通过后再嵌入 Markdown;失败时依据排错指南和搜索优先级进行修复。
  • 提取与图片转换:从 Markdown 中提取 Mermaid 图并检查语法,支持将 .mmd 单个或批量转换为 PNG、SVG,以及用图片替换原文图源。
  • 语义符号增强:按基础设施、计算、数据、消息、安全和监控等类别选用 Unicode 图标,让节点含义更直观。

应用场景

用户怎么说本技能做什么
“把登录和鉴权过程画成时序图,节点加些安全图标。”识别为服务交互场景,生成 Mermaid 时序图,并选用锁、钥匙、用户等 Unicode 安全符号增强语义。
“根据这个 Spring Boot 项目整理架构图和部署图。”按代码转图路径分析 Controller→Service→Repository 结构及部署配置,再选择架构图、部署图或方法级时序图输出。
“帮我写一份 API 设计文档,配图并能导出 PNG。”组合 API 设计模板与相关图表指南,保存并校验 .mmd 后嵌入 Markdown,再转换为 PNG 或 SVG。
“设计文档里有很多 Mermaid,帮我检查并批量转图片。”提取文档中的图源并校验语法,批量输出图片;遇到渲染错误时进入排错与恢复流程,避免把坏图写入文档。