mermaid-diagram-generator

Mermaid 图表生成器

从 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 配合使用，以绘制任务和同步图。
• 与 arduino-code-generator 配合使用，为生成的草图添加可视化文档。
• 与 readme-generator 配合使用，将图表纳入仓库文档。

共享输出约定

使用共享的 Arduino 技能约定： 说明假设、所需工具和版本、实现步骤、各验证阶段的测试/证据、已知限制，以及恢复/安全说明。