ドキュメント

プロジェクトの背景情報

リポジトリだけではエージェントに伝えきれない文書、ポリシー、参照資料を添付してください。

エージェントはコードを読み取ります。コンテキストコンテキストとは、コードでは表現できない決定事項、制約条件、規約などを記載する場所です。

ここに記載すべき内容の理由については、以下をご覧ください。プロジェクトコンテキスト「概念」セクションで説明されています。このページではその管理方法について解説します。

コンテキストの追加

プロジェクトの「コンテキスト」セクションを開き、エントリを追加します。各エントリにはタイトルと本文が含まれ、後から編集や削除も可能です。

良いエントリとは、短く、具体的で、長期にわたって有効なものです。アーキテクチャ上の決定事項、スタイル規約、API契約、所有権の範囲、明確な禁止事項などが該当します。一方で、オンボーディングに関する記述やリポジトリ内で既に明らかな内容は含めません。

エントリは分けて名前を付けて管理しましょう

テーマごとにエントリを作成し、内容を反映したタイトルを付けます。「エラーハンドリングの規約」や「凍結モジュール」といったエントリは検索可能ですが、「備考」という単一のエントリに両方をまとめると検索できなくなります。

これは重要です。なぜなら、コンテキストは作業内容に応じて選択的に読み込まれるからです。詳しくは段階的スキルをご覧ください。適切に分けたエントリであれば、作業に合ったものだけが読み込まれます。

参照資料

文章によるエントリに加えて、参照資料としてリンクや文書を添付できます。正式な情報がWikiやデザインツールに存在し、そこから複製したコピーが古くなるのを防ぎたい場合に利用します。

タスク別コンテキスト

プロジェクト全体に適用されるコンテキストとは別に、チケット、顧客報告書、設計文書など、特定の作業に関連する資料はそのタスクに直接添付します。プロジェクトコンテキストにタスク専用のメモを記載すると、以降のすべてのタスクで不要な情報となってしまいます。

常に正確な状態を保つ

古いコンテキストは、コンテキストが欠如している場合よりも深刻な問題を引き起こします。なぜなら、エージェントはそれを信頼できる情報と判断するからです。規約が変更された際には、コードの変更と同時にエントリも更新してください。

既存のコンテキストを確認する

時折、新入社員の視点でコンテキストを読み返してみてください。エントリは蓄積され、1年前に移行作業で記載された内容が今では誤解を招く情報になっている可能性があります。