/ ディレクトリ / プレイグラウンド / Codebase to Course
← 全サーバー ↗ GitHub
● コミュニティ zarazhangrui ⚡ 即起動

Codebase to Course

作者 zarazhangrui · zarazhangrui/codebase-to-course

リポジトリを指定すると、チュートリアルのように解説する単一HTMLの「コース」が生成される — 注釈付きコード・図・ナラティブ — 非エンジニアや新入社員のオンボーディングに。

codebase-to-courseは、リポジトリ全体を歩き回り、コードベースの実際の動作を説明する単一ファイルHTMLコースを生成するClaude Codeスキルです。チュートリアル形式で構成されています：ハイレベルなアーキテクチャ、モジュールごとの深掘り、そして「このリクエストをシステムで追跡する」ウォークスルー — 埋め込みの注釈付きコードスニペット付き。出力は1つのHTMLファイル、ビルドステップなし。

▶ デモを見る 📦 インストール 💡 ユースケース

なぜ使うのか

主な機能

ライブデモ

実際の動作

準備完了

インストール

作者のリポジトリ · Claude Skills の公式ドキュメント

ユースケース

実用的な使い方： Codebase to Course

新入社員向けのセルフペースオンボーディングコースを生成する

👤 エンジニアリングマネージャー／テックリード ⏱ ~45 min beginner

使うタイミング： 内定承諾の翌金曜日：「コードを読んで」の代わりに本物のオンボーディング成果物が欲しい場合。

フロー
  1. リポジトリをスキャン
    codebase-to-course: scan ./our-app. Output the proposed course structure first — section list — before writing.✓ コピーしました
    → 具体的なTOC：アーキテクチャ・モジュール・リクエストフロー
  2. コースを生成
    Looks good. Generate the full HTML to /onboarding/course.html. Target audience: new full-stack hire who knows React + Node but not our domain.✓ コピーしました
    → HTMLファイルが生成される；ブラウザで開く
  3. 正確さを検証
    Spot-check: does the 'auth flow' walkthrough match what's actually in src/auth/? Quote the real code.✓ コピーしました
    → ウォークスルーが実際のファイルパスと現在のコードを引用している

結果： チームの2週間分の説明を節約できる本物のオンボーディング成果物。

注意点
  • コースが長すぎて実際に読めない — 最大セクション数を指定する；完全性より品質
  • コードの抜粋が古くなる — 大きなリファクタ後に再生成する；スキルは高速
組み合わせ： filesystem · git-mcp-idosal

複雑な機能を非技術PMに説明する

👤 テックリード ⏱ ~20 min beginner

使うタイミング： PMが「なぜ3スプリントかかるの？」と聞き続ける — 具体的な成果物が欲しい場合。

フロー
  1. 機能にスコープを絞る
    codebase-to-course: scope to src/payments/. Audience: PM with no engineering background. Lean on diagrams + analogies, light on code.✓ コピーしました
    → コースがハイレベル；コードブロックが最小限

結果： PMがメンタルモデルを持って帰る。

注意点
  • アナロジーが過度に単純化する — スポットチェックする；プッシュすればスキルは正確さを優先する

オープンソースプロジェクト向けの「動作原理」ページを生成する

👤 OSSメンテナー ⏱ ~30 min intermediate

使うタイミング： READMEに機能はあるがアーキテクチャの解説がない場合。

フロー
  1. docsページとして生成
    codebase-to-course: scan main branch. Output ARCHITECTURE.html for the docs site. Target: experienced devs evaluating the project.✓ コピーしました
    → 出力が思慮深いコントリビューターガイドのように読める

結果： 評価者とコントリビューターにとってより良い開発体験。

注意点
  • コースのブランディングが間違っている（汎用的に見える） — promptにプロジェクト名＋スタイルのヒントを渡す

組み合わせ

他のMCPと組み合わせて10倍の力を

codebase-to-course-skill + filesystem

ローカルリポジトリを読んでコースを書く

codebase-to-course: scan ./our-app, write /onboarding/course.html.✓ コピーしました
codebase-to-course-skill + git-mcp-idosal

クローンせずに外部リポジトリのコースを作る

Use GitMCP for owner/repo. Then codebase-to-course on top of that.✓ コピーしました

ツール

このMCPが提供する機能

ツール入力呼び出すタイミングコスト
scan_repo path 常に最初に実行 0
propose_toc scan_result, audience スキャン後、生成前 0
generate_course scan_result, toc, target_html_path 最終ステップ 0
scope_to_subdir subdir_path 大規模なモノリポや機能フォーカス 0

コストと制限

運用コスト

APIクォータ
N/A
呼び出しあたりのトークン
大きい — スキルはリポジトリ全体を読む（典型的に10k〜50k token）
金額
無料；使用するモデルのtoken料金が適用される
ヒント
モノリポではscope_to_subdirを使用；一度に全体をコース化しないこと

セキュリティ

権限、シークレット、影響範囲

最小スコープ： filesystem-read filesystem-write
認証情報の保管： なし
データ送信先： なし — 純粋なローカルの読み書き

トラブルシューティング

よくあるエラーと対処法

Course is too generic / doesn't reference real code

promptをより具体的にする；file:line引用を要求する

Repo too large; runs out of context

scope_to_subdirを使用；モジュールごとのコースを作成してリンクする

HTML formatting broken

スキルに出力の検証を依頼する；必要なら再生成

代替案

Codebase to Course 他との比較

代替案代わりに使う場面トレードオフ
Repomix + manual promptコードベースのClaudeへの渡し方を完全にコントロールしたい場合セットアップが多い；意見のある出力フォーマットなし
DocsGPT / Mintlifyホスティングされたドキュメントが欲しい場合全く異なる製品；単一ファイルHTMLではない
absolutely-skilled / autodoc自動生成APIドキュメントが欲しい場合APIリファレンス ≠ チュートリアル

その他

リソース

📖 GitHub の公式 README を読む

🐙 オープンな issue を見る

🔍 400以上のMCPサーバーとSkillsを見る