MrLesk/groma.md

解決する問題

アーキテクチャ図は描かれた瞬間に古くなることがよくあります。このツールは、実際のコードの変更に合わせて同期されるソフトウェアアーキテクチャのライブでインタラクティブなマップを作成することで、「古いドキュメント」の問題を解決します。

仕組み

groma.md はリポジトリをスキャンして C4 ベースのアーキテクチャマップを生成します。このマップはプレーンな Markdown ファイルとして Git リポジトリ内に直接保存されます。アーキテクチャがコードとして保存されるため、あなたやコーディングエージェントがマップに加えた変更はすべてバージョン履歴に記録されます。ソースコードを変更すると、マップは自動的に更新されて新しい構造を反映し、手動でのキュレーション、説明、コンポーネントのグループ化は保持されます。

対象読者

図の更新を手動で行うことなく、正確で最新のアーキテクチャドキュメントを維持したい開発者やチーム向けです。AI コーディングエージェントを使用する人に特に役立ちます。エージェントがコードと一緒にアーキテクチャドキュメントを読み取り、更新できるためです。

ハイライト

• ライブ更新: コードを保存するとマップが自動的に更新され、ドキュメントが現在の作業を反映します。
• ローカルでプライベート: ツールは完全にローカルで動作し、アカウントは不要で、コードを外部の AI サービスに送信しません。
• バージョン管理: アーキテクチャがリポジトリ内の Markdown として保存されるため、コードと同じプルリクエストでアーキテクチャの変更を確認できます。
• インタラクティブなブラウザマップ: 組み込みの Web インターフェースにより、システム、コンテナ、コンポーネントをズームして、背後にあるソースコードに直接リンクできます。
• 拡張可能: プラグインベースのスキャナーシステムにより、幅広いプログラミング言語をサポートします。