How to 大規模コードベースを理解する with Eigent

仕組み

1. 理解したい関連ファイル、ディレクトリ、または機能領域を Eigent に渡します。
2. リクエストの流れをたどり、どのモジュールがビジネスロジック、トランスポート、永続化、または UI を担当しているかを説明するよう依頼します。
3. 何かを編集する前に、検証、副作用、または状態遷移がどこで発生するかを尋ねます。
4. 最後に、次に読むべきファイルと注意すべきリスク箇所を確認します。

追加で試せるプロンプト

• 実際のビジネスロジックは、トランスポート層や UI 層のどのモジュールが担当していますか？
• 検証はどこで行われ、その場でどのような前提が強制されていますか？
• このフローを変更したときに見落としやすい関連ファイルやバックグラウンドジョブは何ですか？
• この領域を編集した後に実行すべきテストやチェックは何ですか？
• このリポジトリを高レベルで俯瞰して、全体像を教えてください。

使い方

コードベースを接続した状態で Eigent を開きます。初心者ならまずは広く質問し（「このリポジトリを高レベルで説明してください」）、その後、変更したい具体的な領域へ絞り込みます。リクエストの範囲を明確にするほど、たとえば機能名、ディレクトリ、リクエストパスなどを指定するほど、説明はより具体的になります。最初の編集を安心して行えると確信できるレベルになるまで、追加質問を続けてください。

期待される出力

どのコードが何を担当しているかを示す具体的なモジュールマップ、追跡されたリクエストフロー、主要な検証ポイント、注意が必要または見落としやすい領域の一覧、そして変更前に確認すべき次のファイルの読み物リスト。

制限事項

• リポジトリ全体について一度に尋ねるより、特定の領域に絞って質問した方が最も効果的です。
• 非常に大きなモノレポでは、まず単一のサービスまたはパッケージに絞ると効果的です。
• Eigent は接続されたコードベースに含まれる内容を読み取ります。観測していないランタイムの動作を推論することはできません。