プロジェクトオンボーディング
生産性入門
初めてのプロジェクトのディレクトリ構造、技術スタック、主要ファイル、重要フローを自動で分析し、プロジェクトを素早く理解できるようサポートします。
トリガー
/onboard使用頻度プロジェクト参画時
転職初日や新プロジェクトにアサインされた開発者なら？ /onboardで5分で全体構造を把握しすぐに貢献開始
オンボーディング探索理解
動作フロー
/onboard 実行
↓
フェーズ1: 4つのスキャンを並列実行
dir-scan
ディレクトリ構造スキャン
stack-detect
技術スタック検出
file-map
主要ファイルマッピング
flow-trace
主要フローの追跡
↓
概要ドキュメント生成
↓
✓ 技術スタック + 主要ファイル + アーキテクチャ + Quick Start
スキルコード
# Project Onboarding Skill
## Trigger: /onboard
When invoked in a new project:
1. Scan project structure:
- Directory tree (2 levels deep)
- Key config files
- README.md content
2. Detect tech stack:
- Language and framework
- Database and ORM
- Testing framework
- CI/CD setup
3. Identify key files:
- Entry points (main, index, app)
- Route definitions
- Database models/schemas
- Environment config
4. Map core flows:
- Request lifecycle
- Data flow
- Authentication flow
5. Output:
---
## 🗺️ Project Overview
### Tech Stack
[framework] + [language] + [database]
### Key Files
- Entry: `src/index.ts`
- Routes: `src/routes/`
- Models: `src/models/`
### Architecture
[brief description of patterns used]
### Quick Start
```bash
[install command]
[run command]
```
### Key Concepts
- [concept 1]: [explanation]
- [concept 2]: [explanation]
---
コピーしてCLAUDE.mdに貼り付ければ、すぐに使えます。
プロジェクトオンボーディング の仕組み
Project Onboardingは新しいコードベースのディレクトリ構造、設定ファイル、主要モジュールをスキャンし、アーキテクチャパターン、エントリーポイント、主要な依存関係、開発ワークフローを含む簡潔なオリエンテーションガイドを生成します。
プロジェクトオンボーディング が力を発揮する場面
新しいプロジェクトやチームに参加する際のキャッチアップ時間を劇的に短縮します。コードを何日もかけて読む代わりに、アーキテクチャの全体像を即座に把握し、各機能がどこにあるかを正確に知ることができます。
主な強み
- 数日ではなく数分でアーキテクチャの概要を生成
- エントリーポイントと主要モジュールを自動特定
- コンポーネント間の依存関係をマッピング
- コードベース構造のメンタルモデルを生成