developer-onboarding

Name: developer-onboarding
Author: jonathimer

github.com/jonathimerマーケティング・グロース87102 回インストール35 週間前に更新

リポジトリ

developer-onboarding について

プロダクトや開発者マーケティングチーム向けのオンボーディング設計スキルです。クイックスタート、失敗からの復旧、アクティベーション測定まで扱います。

主な機能

01初回価値到達時間の短縮
02クイックスタートチェックリストの設計
03インタラクティブ教材と静的教材の選択
04サンプルアプリとテンプレートの計画
05エラー復旧の改善
06アクティベーションファネルの測定

活用シーン

01登録から初回成果までの障壁の監査
02タスク中心のクイックスタート作成
03オンボーディング時のエラーと復旧方法の確認
04ユーザーコホート別のアクティベーション追跡

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/jonathimer/devmarketing-skills --skill developer-onboarding

インストール後、Claude Code で/developer-onboardingを入力して読み込まれたか確認します。

同梱ファイルREADME.md

詳細

開発者オンボーディング

開発者が登録してから、できるだけ早く動作するコードを書けるようにし、その後、さらに深く活用できるよう導きます。

概要

開発者オンボーディングは、「登録した」から「これをどう使うか理解した」までの重要な期間です。開発者が注意を向けてくれる時間は約10分です。戸惑う時間、案内のないエラーメッセージ、「動くはずなのに動かない」という瞬間が一つ一つ、ユーザーを失う原因になります。

優れたオンボーディングは、あらゆる質問を先回りしてくれる相手とのペアプログラミングのように感じられます。悪いオンボーディングは、地図もないまま異国の街に放り出されたように感じられます。

始める前に

/devmarketing-skills/skills/developer-audience-context スキルを確認し、対象となる開発者について理解してください。サイドプロジェクトを作る趣味の開発者と、本番環境用のツールを評価するエンタープライズアーキテクトとでは、必要なオンボーディングが異なります。登録からオンボーディングへスムーズに移行できるよう、/devmarketing-skills/skills/developer-signup-flow も確認してください。

最初の価値を得るまでの時間の最適化

「最初の価値」の定義

最初の価値とは、「API 呼び出しを行った」ことではありません。開発者が、ツールが自分にとって役立つ動作をするのを目にしたときが、最初の価値です。

ツールの種類	最初の価値を得る瞬間
API	意味のあるデータがレスポンスとして返る
SDK	ライブラリが期待どおりの機能を実行する
データベース	クエリから結果が返る
ホスティング	アプリが公開され、アクセスできる
認証	ユーザーが正常にログインする
決済	テスト決済が処理される

最初の価値を得るまでの時間（TTFV）の測定

各段階のタイムスタンプを記録します。

signup_completed: 2024-01-15T10:00:00Z
dashboard_loaded: 2024-01-15T10:00:05Z
api_key_copied: 2024-01-15T10:01:30Z
first_api_call: 2024-01-15T10:04:45Z
first_successful_response: 2024-01-15T10:04:46Z  # TTFV = 4:46

カテゴリー別のベンチマーク：

シンプルな API：5分未満
インストールが必要な SDK：10分未満
複雑なインフラストラクチャ：30分未満
セルフホスト型：60分未満

TTFV の障害を取り除く

すべての手順を洗い出し、障害を取り除きます。

よくある TTFV の阻害要因：

ダッシュボードにアクセスする前にメール認証を求める
API キーがアカウント設定の中に隠れている
クイックスタートで、依存関係がすでにインストールされていることを前提にしている
最初のサンプルで有料機能が必要になる
解決方法の案内がないエラーメッセージ
ドキュメント検索で古いチュートリアルが見つかる

TTFV の監査手順：

新しいアカウントを作成する（新しいブラウザーを使用し、Cookie がない状態で行う）
最初の30分間を画面録画する
戸惑いや手間を感じた瞬間をすべて記録する
各手順にかかった時間を測る
5種類の異なる開発者ペルソナで繰り返す

クイックスタートのチェックリスト設計

理想的なクイックスタートの構成

# Quickstart: [Specific Goal] in 5 Minutes

What you'll build: [Screenshot or description of end result]

Prerequisites:
- Node.js 18+ (check: node --version)
- npm or yarn

## Step 1: Install the SDK
[One command, copy button]

## Step 2: Initialize with your API key
[Code with placeholder, copy button]

## Step 3: Make your first request
[Complete working example, copy button]

## Step 4: See the result
[Expected output shown]

## Next steps
- [Link to common second task]
- [Link to full documentation]

効果的なチェックリストのパターン

進行状況インジケーター（Stripe 形式）：

Your integration progress:
[x] Create account
[x] Get API keys
[ ] Install SDK
[ ] Make first API call
[ ] Handle webhooks

状況に応じた次のステップ（Vercel 形式）：

You've deployed your first site.

What's next?
[ ] Add a custom domain
[ ] Set up environment variables
[ ] Enable analytics

よくあるクイックスタートの失敗

最初に説明しすぎる：

# Bad: The history of authentication
Before we begin, let's understand OAuth 2.0...
[500 words of background]

# Good: Jump to action
Install the SDK and make your first authenticated request.

環境を前提にしている：

# Bad
Run `npm install` to install dependencies.

# Good
npm install our-sdk
# Or with yarn: yarn add our-sdk
# Or with pnpm: pnpm add our-sdk

前提条件が隠れている：

# Bad (prerequisite discovered in Step 3)
Step 3: Connect to Redis
First, make sure Redis is running...

# Good (prerequisites listed upfront)
Prerequisites:
- Redis 6+ running locally (docker run -p 6379:6379 redis)

インタラクティブなチュートリアルと静的なチュートリアル

インタラクティブなチュートリアルを使う場合

インタラクティブなチュートリアルが効果的なケース：

複雑なセットアップ手順
すぐにフィードバックが得られると理解しやすい概念
環境を制御できるオンボーディングフロー
API キーや認証情報が必要な機能

インタラクティブなチュートリアルツール：

埋め込み型コードエディター（CodeSandbox、StackBlitz）
ターミナルエミュレーター（Instruqt、Killercoda）
ダッシュボード内のガイドツアー（Appcues、Pendo）
インタラクティブなノートブック（Jupyter、Observable）

静的なドキュメントが適している場合

静的なドキュメントがより効果的なケース：

リファレンスドキュメント
コピーして使えるコードスニペット
ローカル開発を伴う手順
頻繁に更新されるコンテンツ

ハイブリッドアプローチ

ベストプラクティス：両方を提供する

# Make Your First API Request

## Quick version (copy-paste)
[Code block with copy button]

## Interactive version
[Launch in StackBlitz] [Try in CodeSandbox]

## Video walkthrough
[5-minute embedded video]

インタラクティブなチュートリアルの UX ガイドライン

推奨事項：

進行状況を自動保存する
先の手順に進めるようにする
残り時間の目安を表示する
静的なドキュメントに移動できる手段を用意する
モバイルブラウザーでも動作するようにする（少なくとも閲覧できるようにする）

避けるべきこと：

チュートリアルの利用にアカウント作成を必須にする
動画を自動再生する
手順を完了するまでコンテンツをロックする
事前の警告なしに、操作のないセッションをタイムアウトさせる
特定の IDE やブラウザーを必須にする

サンプルアプリとテンプレート

テンプレート戦略

段階的なアプローチ：

最小限の例（Hello World）
- 単一ファイル
- SDK 以外の依存関係はゼロ
- 30 秒で動作
- 目的：SDK が動作することを証明する
スターターテンプレート（基本アプリ）
- シンプルなフォルダー構成
- 一般的なパターンを紹介
- 5 分で動作
- 目的：実際のプロジェクトの出発点にする
本番用テンプレート（完全なアプリ）
- 本番環境に対応したアーキテクチャ
- 認証、エラー処理、テストを含む
- 30 分で動作
- 目的：リファレンス実装にする

テンプレートの構成

github.com/your-org/
├── examples/
│   ├── minimal/
│   │   ├── node/
│   │   ├── python/
│   │   └── go/
│   ├── starter/
│   │   ├── nextjs/
│   │   ├── express/
│   │   └── fastapi/
│   └── production/
│       ├── saas-starter/
│       └── internal-tool/

テンプレートのメンテナンス

動作しないテンプレートは、テンプレートがないよりも悪いものです。

テンプレートの健全性チェックリスト：

CI ですべてのテンプレートを毎週テストする
依存関係を毎月更新する
SDK のバージョンを固定し、リリースに合わせて更新する
新しいコントリビューターが四半期ごとに README をテストする
削除前に非推奨の告知を追加する

実例

優れたテンプレート：Supabase

複数のフレームワーク向けのテンプレート
Vercel／Netlify へのワンクリックデプロイ
認証、データベース、ストレージのパターンを含む
積極的にメンテナンスされている

優れたテンプレート：Clerk

フレームワーク別のクイックスタート
認証フローを完全に網羅
段階的な複雑さ（最小限 → フル機能）

オンボーディングの失敗に適切に対処する

よくある失敗ポイント

インストールの失敗
- 依存関係の競合
- バージョンの不一致
- プラットフォーム固有の問題
認証の失敗
- 無効な API キー
- 期限切れのトークン
- 環境の誤り（テスト環境と本番環境）
初回リクエストの失敗
- ネットワークの問題
- CORS の問題
- レート制限
- 無効なリクエスト形式

エラーメッセージの設計

悪いエラーメッセージ：

Error: Request failed with status 401

良いエラーメッセージ：

Authentication failed: Invalid API key

Your API key starts with 'sk_test_' but you're calling the production endpoint.

To fix:
1. Use the production API key (starts with 'sk_live_'), or
2. Change endpoint to https://api.example.com/test/

Docs: https://docs.example.com/auth#environments

失敗の予防策

よくある間違いをリアルタイムで検出する：

// Client SDK that catches common errors
if (apiKey.startsWith('sk_test_') && endpoint.includes('/v1/')) {
  console.warn(
    'Warning: Using test API key with production endpoint. ' +
    'This will fail. Use production key or test endpoint.'
  );
}

復旧フロー

ダッシュボード内でのエラーからの復旧：

Something went wrong with your integration.

We detected:
- Last API call: 2 hours ago
- Status: 401 Unauthorized
- Likely cause: API key rotated

[Regenerate API Key] [View Error Logs] [Contact Support]

アクティベーション指標の測定

アクティベーションの定義

アクティベーションとは、開発者が製品を使い続けるのに十分な成果を得た時点です。

製品ごとに、アクティベーションの定義は異なります。

製品	アクティベーションの定義
Stripe	テスト決済の初回成功
Twilio	SMS の初回送信と配信
Auth0	初回のユーザー認証
Vercel	URL からアクセス可能な初回デプロイ
Algolia	検索で初めて結果が返されること

主なアクティベーション指標

アクティベーション率

Activated users / Signed up users × 100

ベンチマーク：セルフサービス型の開発者向け製品では 20～40％

アクティベーションまでの時間

Median time from signup to activation event

ベンチマーク：API は 10 分未満、インフラストラクチャは 1 時間未満

コホート別のアクティベーション 改善点を特定するため、週次または月次のコホートを追跡します。

Week 1 cohort: 25% activation
Week 2 cohort: 28% activation (added better error messages)
Week 3 cohort: 35% activation (added interactive tutorial)

先行指標

アクティベーションを予測する行動を追跡します。

先行指標	アクティベーションとの相関
API キーをコピーした	可能性が 2 倍
クイックスタートを閲覧した	可能性が 1.5 倍
SDK をインストールした	可能性が 3 倍
Discord に参加した	可能性が 2.5 倍

遅行指標

アクティベーションが価値につながったことを確認します。

遅行指標	意味
7 日目の継続率	1 週間後も使い続けている
2 週目の API 呼び出し	開発を継続している
有料プランへのアップグレード	十分な価値を感じている
チームメンバーを招待した	利用を拡大している

アクティベーションファネルの例

Signed up: 1,000
├── Visited dashboard: 950 (95%)
├── Viewed quickstart: 700 (74%)
├── Copied API key: 500 (71%)
├── Made first API call: 350 (70%)
├── Got successful response: 300 (86%)  ← Activation
├── Made 10+ API calls: 150 (50%)
└── Day 7 return: 100 (67%)

オンボーディングメールのシーケンス

メールのタイミング

メール	タイミング	目的
ウェルカム	即時	登録を確認し、主要なリンクを案内する
はじめに	+1 時間	まだの場合、初回の API 呼び出しを促す
ヒント	+1 日	よくあるパターンを紹介する
状況確認	+3 日	行き詰まっていないか尋ね、サポートを申し出る
アクティベーションの促進	+7 日	アクティベーションしていない場合、最後の後押しをする

メールコンテンツの原則