codebase-onboarding

コードベースのオンボーディング

コードベースを並行して調査し、包括的なオンボーディングドキュメントを作成します。

ワークフロー

1. 並行調査エージェントを起動する

異なる領域を調査する explore サブエージェントを5つ起動します。

エージェント1 — アーキテクチャと構成

「トップレベルのディレクトリ構成をマッピングしてください。フレームワーク（Next.js、Express、Djangoなど）、モノレポツール（turbo、nx）、主要な設定ファイルを特定してください。すべてのアプリ／パッケージと、それぞれの役割を一覧にしてください。」

エージェント2 — データモデルとデータベース

「すべてのデータベーススキーマ、ORMモデル、マイグレーション、シードファイルを探してください。すべてのエンティティと、そのフィールドおよびリレーションシップを一覧にしてください。データベース（Postgres、MySQL、MongoDBなど）とORM（Prisma、Drizzle、SQLAlchemyなど）を特定してください。」

エージェント3 — APIルートとエンドポイント

「すべてのAPIルート定義を探してください。すべてのエンドポイントについて、HTTPメソッド、パス、認証要件、機能を一覧にしてください。APIスタイル（REST、GraphQL、tRPC）を特定してください。」

エージェント4 — 認証と認可

「認証の仕組みを調べてください。認証プロバイダー（Auth.js、Clerk、Supabase Auth、カスタムなど）、セッション管理、保護されたルート、ロール／権限チェック、ミドルウェアを特定してください。」

エージェント5 — デプロイとインフラストラクチャ

「デプロイ設定（Dockerfile、Vercel設定、fly.toml、terraform）、CI/CDパイプライン（GitHub Actionsなど）、必要な環境変数、アプリをローカルで実行する方法を調べてください。」

2. 統合する

5つのエージェントの結果を、1つのオンボーディングドキュメントにまとめます。

# Codebase Onboarding

## Quick Start
1. Clone the repo
2. Install dependencies: `<command>`
3. Set up environment: copy `.env.example` to `.env`
4. Run database migrations: `<command>`
5. Start dev server: `<command>`

## Architecture
<Agent 1 findings>

## Data Models
<Agent 2 findings>

## API Reference
<Agent 3 findings>

## Authentication
<Agent 4 findings>

## Deployment
<Agent 5 findings>

## Key Files to Know
- `<file>` — <why it matters>

3. 保存する

ドキュメントをプロジェクトのルートにある ONBOARDING.md、またはユーザーが指定した場所に書き込みます。

ヒント

• 各調査エージェントは読み取り専用で高速です。全体の作業は1分以内で完了します。
• モノレポの場合は、アプリ／パッケージごとに追加のエージェントを1つ起動することを検討してください。
• ドキュメントには独自の見解を盛り込み、すべてを列挙するだけでなく、「まずここから始める」べきファイルを強調してください。
• よくあるセットアップの問題、忘れやすい環境変数、必要なシステム依存関係など、注意点も含めてください。