DEV Community 日本語
フォロー
エージェントにメモリは不要、ドキュメントが必要:実践的なAGENTS.mdプレイブック
最近、AIコーディングエージェントを使用するグループは、セッションごとにエージェントがすべての情報を忘れてしまうという問題に頻繁に直面しています。複雑な「メモリ」ソリューションを探す代わりに、この記事ではリポジトリ内のドキュメントを使用してこの問題を解決することを提案しています。従来のメモリには、検証不可能、レビュー不可能、共有不可能という3つの弱点があります。対照的に、リポジトリ内のドキュメントはGitによって制御され、プルリクエストを通じてレビューされ、すべてのエージェントとすべての人が単一の情報源を使用します。これにより、一貫性が確保され、エラーの修正が容易になります。ドキュメントの構造は3つのレベルに分かれています。AGENTS.md(150行未満)にはルールとコマンドが含まれ、docs/agents/*.mdには各モジュールの詳細なドキュメントが含まれ、docs/adr/にはアーキテクチャ決定記録が含まれます。サンプルAGENTS.mdには、必須コマンド、ハードルール、モジュールマップ、および不確かな場合のガイダンスが含まれています。ドキュメントを作成する際の重要な原則は、正確なコマンドを記述し、ハードルールに短い理由を付け、エージェントが間違ったことをするたびにドキュメントに1行追加することです。ドキュメントの陳腐化を防ぐために、著者はリポジトリマップを自動生成するスクリプト(repo-map.sh)と、CIでコードに対するドキュメントの遅延をチェックするPythonスクリプト(check_doc_drift.py)を使用しています。このスクリプトは、関連するドキュメントが更新されていないコードが14日以上変更された場合にエラーを報告します。完全なワークフローには、エージェントがドキュメントを読み、コードを修正し、PRを開き、CIがドキュメントをチェックし、レビュー/マージが含まれます。結論として、ドキュメントをバージョン管理され、レビューされ、共有されるメモリと見なすことで、エージェントはより効率的に作業できます。具体的なアクションには、簡潔なAGENTS.mdの作成、エージェントが間違ったことをするたびにドキュメントへの追加、陳腐化しやすいドキュメントの自動生成、CIへのドキュメント遅延チェックの組み込み、およびADRを使用したアーキテクチャ決定の記録が含まれます。このアプローチは、エージェントを助けるだけでなく、新しい同僚がプロジェクトに簡単にアクセスできるようにサポートします。