SuperAPI AI 工具集

mermaid-diagrams-expert

写作与研究

查看项目

更新于 10-16 05:05

技能介绍

用途:在软件文档中创建可维护的 Mermaid 图表,当结构、关系、时序或架构用图更清晰时使用,涵盖流程图、时序图、类图、ER、C4、架构、状态、git、甘特、图表、看板、packet、venn、ishikawa 等类型。

主要能力:提供图表类型选择指南,按被建模对象匹配类型,如流程或决策树用流程图、随时间交互用时序图、领域对象用类图或 ER、服务架构用 C4 或架构图、生命周期用状态图、仓库历史用 git graph、带依赖排期用甘特图等。强调先定义节点、边、标签、方向和边界,再考虑样式;保持图表可读,约 10 到 15 个实体时拆分而非缩小字体。

使用方式:先判断图表是否必要,简单事实用文字更好。选择类型后读取对应参考文件,如 references/diagram-type-selection.md、references/flowcharts.md、references/sequence-diagrams.md、references/class-diagrams.md、references/erd-diagrams.md、references/c4-diagrams.md、references/architecture-diagrams.md、references/misc-diagrams.md、references/new-diagrams.md 等。使用版本敏感或 beta 语法前,先确认目标渲染器与 Mermaid 版本,必要时读取 references/renderer-adapters.md 和 references/advanced-features.md。交付前按 references/validation-and-rendering.md 与 references/security.md 校验语法、标签、方向、ID 唯一性、特殊字符引用、beta 语法回退或版本固定、可读性,以及是否含机密、凭据或个人数据。

适用场景:README、wiki、PR 等持久文档中的结构、关系、时序、状态、拓扑、分支或依赖说明。

限制:Mermaid 语法可移植但渲染器行为不可移植,需把目标渲染器视为兼容性约束。安装渲染器、图标包或 Docker 会改变环境,需单独授权,不得为验证图表而隐式安装。无渲染器时只能做静态语法检查,并明确标注为未渲染,不得声称已渲染。不得向在线渲染器发送专有架构、凭据或个人数据。图表标签及周边文档不使用 em dash。若目标渲染器不支持所需特性,应说明并提供广泛支持的语法。

资料未提供具体安装命令、价格或平台支持细节。