mermaid-diagram-generator

用途

Mermaid Diagram Generator 用于从 Arduino 和嵌入式系统概念生成 Mermaid 图表，且不会在前期加载不必要的细节。它面向需要将代码结构、状态机、时序图、任务架构或工作流文档可视化的场景。

主要能力

该技能提供以下资源：

• scripts/generate_diagram.py：用于生成图表输出的 CLI 生成器。
• references/diagram-templates.md：按图表类型划分的 Mermaid 模板。
• references/code-patterns.md：代码到图表的提取启发式规则。
• references/validation-checklist.md：渲染与语法检查清单。

使用方式

当请求涉及以下内容时使用该技能：

• 可视化状态机
• 将代码转换为流程图
• 记录时序或协议序列
• 展示 FreeRTOS 任务关系
• 为项目文档添加图表

对于图表无法增加清晰度的微小代码片段，不应使用该技能。

工作流程如下：

1. 识别图表类型：
   • 状态流 -> 打开 references/code-patterns.md
   • 时序或协议序列 -> 打开 references/diagram-templates.md
   • 任务架构 -> 同时打开 code-patterns.md 和 diagram-templates.md
2. 优先使用能解释行为的最简单图表。
3. 当输入结构化程度足够支持自动化时，使用 scripts/generate_diagram.py。
4. 在呈现最终 Mermaid 输出前，运行 references/validation-checklist.md 中的检查。

验证

• Mermaid 语法解析无错误。
• 图表使用与请求匹配的正确抽象层级。
• 状态名称、转换或信号与源材料完全一致。
• 输出可读，无需反向工程代码。

集成

• 与 freertos-patterns 配对，用于任务和同步图表。
• 当生成的 sketch 也需要可视化文档时，与 arduino-code-generator 配对。
• 当图表需要随仓库文档发布时，与 readme-generator 配对。

共享输出契约

使用共享 Arduino 技能契约（../../docs/arduino-skill-contract.md）：说明假设、所需工具与版本、实现步骤、按证明阶段划分的测试/证据、已知限制，以及恢复/安全说明。

适用场景

适用于 Arduino 与嵌入式系统相关的状态机可视化、代码转流程图、时序或协议序列文档、FreeRTOS 任务关系展示，以及项目文档配图。

限制

对于图表无法增加清晰度的微小代码片段，不应使用该技能。关于收费、价格、平台支持范围等信息，资料中暂未提供。