完了すると得られるもの
実際のファイルに基づいた、新メンバー向けのコードベース案内。
始める前に
- ドキュメントファイルを 1 つ作成してよい
手順
- ビルドと実行のエントリーポイントを特定する
- 代表的なリクエストを 1 つ追う
- データと権限の境界を説明する
- 安全な変更と危険な近道を挙げる
成果物
- アーキテクチャ図
- 主要ファイルの索引
- 最初の変更の提案
完了条件
- 各セクションが実際のファイルにリンクしている
- 直接変更すべきでない場所がはっきり書かれている
Agent に渡すプロンプト
新メンバー向けのコードベース案内を作ってください。実行のエントリーポイント、エンドツーエンドの流れ 1 つ、データの境界、設定、テスト、デプロイを追い、実際のファイルを引用して、安全な最初の変更、危険な近道、不明な点を挙げてください。まず目次を見せ、承認を得てからドキュメントファイルを 1 つだけ作成してください。