SuperAPI AI 工具集

alterlab-mermaid

办公与效率

查看项目

更新于 10-15 19:56

技能介绍

用途:以 Markdown 加内嵌 Mermaid 图表作为科学文档的默认与规范格式,适用于 README、操作指南、决策记录、项目文档、状态报告、分析报告,以及工作流、数据管道、架构、时间线、模式等结构或关系图。核心理念是文本图表优于图片:可在 git 中清晰 diff、无需构建步骤、在 GitHub/GitLab/Notion/VS Code 原生渲染、比同义文字更省 token,且可后续转为图片,但文本版本始终是源。

主要能力:提供 23 种 Mermaid 图表类型指南(流程图、时序、ER、状态、甘特、饼图、C4、思维导图、时间线、类图、用户旅程、象限、需求、桑基、XY 图、块图、看板、架构、雷达、树图、数据包、Git 图、ZenUML)及多图组合示例;提供 Markdown 与 Mermaid 两份样式指南;提供 9 类文档模板(决策记录、操作指南、issue、看板、演示、项目文档、拉取请求、研究论文、状态报告)。

使用方式:先判断文档类型并选用模板;写 .md 前阅读 references/markdown_style_guide.md;选图表类型后阅读 references/mermaid_style_guide.md 及对应类型文件;按模板撰写并内联放置图表;以 .md 文本提交。强制规则包括每个图表加 accTitle 与 accDescr、禁用 %%{init} 与内联样式(只用 classDef)、节点 ID 用 snake_case、每节点最多一个 emoji。

限制:Mindmap、Sankey、Block 等类型不支持 accTitle/accDescr,需改用斜体说明段落;不同渲染器捆绑的 Mermaid 版本不同,布局与主题可能不一致,不应针对单一渲染器手工调间距;venn-beta、ishikawa-beta、wardley-beta、swimlane、use case、agentflow-beta 等新类型无本技能指南。本技能不用于手稿正文写作、出版级 AI 图像、真实数值绘图或 PDF/Office 转 Markdown,这些应使用其他技能。内容多移植自 Apache-2.0 许可的 SuperiorByteWorks-LLC/agent-project 仓库。