关于 mermaid
Mermaid Diagrams 技能可将关系、流程等结构化信息转为有效的 Mermaid 源码,帮助选择合适图表类型、编写简洁语法并检查结构,适用于 Markdown 文档。
主要功能
- 01按任务选择图表类型
- 02生成完整的 Mermaid 源码
- 03保持标签与布局易读
- 04检查图表结构和渲染
- 05将 UML 与托管编辑需求分流
适用场景
- 01绘制流程或决策图
- 02呈现调用、状态或数据关系
- 03在 Markdown 文档中加入图表
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ full-stack-skills/ document-skills --skill mermaid安装后在 Claude Code 中输入/mermaid确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
LICENSE.txtagents/openai.yamlexamples/architecture.mdblock.mdc4.mdclass.mder.mdflowchart.mdgantt.mdgitgraph.mdjourney.mdkanban.mdmindmap.mdpacket.mdpie.mdquadrant.mdradar.mdrequirement.mdsankey.mdsequence.mdstate.mdtimeline.mdtreemap.mdxychart.mdzenuml.md详细介绍
Mermaid 图表
生成有效的 Mermaid 源码,让关系比文字描述更清晰。
路由
- Markdown 原生图表默认选择 Mermaid。
- 对于严格的 UML 记法、详细的 C4 或
.puml输出,选择plantuml技能。使用以下命令安装:npx skills add full-stack-skills/document-skills --skill plantuml。 - 用户明确要求使用 ProcessOn 或托管式可编辑渲染时,选择
processon-diagram-generator技能。使用以下命令安装:npx skills add full-stack-skills/document-skills --skill processon-diagram-generator。 - 上下文已能确定安全的默认选项时,不要询问用户选择工具。
工作流
- 从请求和可用来源中提取实体、状态、决策、消息或依赖关系。
- 选择最精简且合适的图表类型。
- 生成语法完整的 Mermaid 源码。
- 保持标签简洁;包含标点、括号或特殊字符的标签要加引号。
- 验证结构;如果有 Mermaid 渲染器可用,交付前先渲染。
- 仅当用户要求提供文件,或图表属于现有文档时,才保存文件。
图表选择
| 需求 | Mermaid 声明 |
|---|---|
| 流程或决策 | flowchart TD 或 flowchart LR |
| 随时间发生的调用 | sequenceDiagram |
| 状态生命周期 | stateDiagram-v2 |
| 类型关系 | classDiagram |
| 数据实体 | erDiagram |
| 日程安排 | gantt |
| 用户体验 | journey |
| 层级结构 | mindmap |
| 时间顺序 | timeline |
| 轻量级架构 | architecture-beta 或流程图 |
仅在需要了解语法细节时,加载 examples/ 下对应的文件。不要加载所有示例。
编写规则
- 为每个节点指定稳定、简洁的标识符。
- 包含标点的可读标签要加引号。
- 始终使用同一个方向;避免不必要的交叉连线。
- 使用菱形表示决策,并标注分支连线。
- 明确列出时序图中的参与者和消息。
- 除非已知目标平台,否则避免使用依赖单一渲染器的样式。
- 图表难以阅读时应拆分,而不是缩小标签或添加过多子图。
- 不要为了让图表看起来完整而加入缺乏依据的事实。
输出
以内联方式交付时,返回一个围栏代码块:
```mermaid
flowchart LR
A["Input"] --> B{"Valid?"}
B -->|Yes| C["Process"]
B -->|No| D["Reject"]
```
以文件形式交付时,优先使用 docs/diagrams/<descriptive-name>.md,除非仓库已有图表规范。保留现有文件,覆盖前先征求同意。
验证清单
- 开头声明与预期的图表类型一致。
- 标识符有效且唯一。
- 包含标点的标签已加引号。
- 所有分支、参与者和关系均按预期连接。
- Markdown 围栏代码块已闭合。
- 如果用户的目标平台有可用的渲染器,图表应能在该平台上渲染。
评论
支持 Markdown