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 スキル仕様に従い、前提条件、必要なツールとバージョン、実装手順、証明段階ごとのテスト／証拠、既知の制限事項、復旧とセキュリティに関する注意事項を示してください。