mcpField
C
codebase-onboarding

codebase-onboarding

github.com/alirezarezvani開発28.9k709 回インストール2 日前に更新
リポジトリ

codebase-onboarding について

エンジニア、テックリード、コントラクター向けのコードベース導入スキルです。リポジトリの構成、言語、設定を分析し、対象者に合わせた環境構築、アーキテクチャ、貢献手順の文書作成を支援します。

主な機能

  1. 01アーキテクチャと技術スタックの把握
  2. 02主要ファイルと設定の一覧化
  3. 03ローカル環境構築ガイド
  4. 04対象者に応じたドキュメント
  5. 05デバッグと貢献のチェックリスト

活用シーン

  1. 01新しいエンジニアやコントラクターの導入準備
  2. 02大規模リファクタリング後の文書更新
  3. 03社内引き継ぎ資料の作成
  4. 04サービス導入資料の標準化

インストール

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

$npx skills add https://github.com/alirezarezvani/claude-skills --skill codebase-onboarding

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

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
onboarding-template.md
output-format-templates.md
scripts/
codebase_analyzer.py

詳細

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

Tier: POWERFUL
Category: エンジニアリング
Domain: ドキュメント／開発者エクスペリエンス

概要

コードベースを分析し、エンジニア、テックリード、業務委託者向けのオンボーディングドキュメントを作成します。このスキルは、情報を迅速に収集し、再現性のあるオンボーディング資料を作成することに最適化されています。

主な機能

  • リポジトリの情報からアーキテクチャと技術スタックを特定
  • 新しいコントリビューター向けに主要なファイルと設定を一覧化
  • ローカル環境のセットアップと一般的なタスクの手順を作成
  • 対象読者に合わせてドキュメントの構成を調整
  • デバッグとコントリビューション用チェックリストのひな形を作成

使用するタイミング

  • 新しいチームメンバーや業務委託者のオンボーディング
  • 大規模なリファクタリング後に古くなったプロジェクトドキュメントを再構築
  • 社内引き継ぎドキュメントを準備
  • サービス向けの標準化されたオンボーディング資料を作成

クイックスタート

# 1) Gather codebase facts
python3 scripts/codebase_analyzer.py /path/to/repo

# 2) Export machine-readable output
python3 scripts/codebase_analyzer.py /path/to/repo --json

# 3) Use the template to draft onboarding docs
# See references/onboarding-template.md

推奨ワークフロー

  1. scripts/codebase_analyzer.py を対象のリポジトリに対して実行します。
  2. 主要な情報を記録します。ファイル数、検出された言語、設定ファイル、トップレベルの構成などです。
  3. references/onboarding-template.md のオンボーディングテンプレートを埋めます。
  4. 対象読者に合わせて出力の詳しさを調整します。
    • ジュニア：セットアップとガードレール
    • シニア：アーキテクチャと運用上の懸念事項
    • 業務委託者：担当範囲と統合境界

オンボーディングドキュメントのテンプレート

詳細なテンプレートとセクションの例は、以下にあります。

  • references/onboarding-template.md
  • references/output-format-templates.md

よくある落とし穴

  • クリーンな環境でセットアップコマンドを検証せずにドキュメントを作成する
  • 業務委託者向けのドキュメントにアーキテクチャの詳細な解説を混在させる
  • トラブルシューティングや検証手順を省略する
  • オンボーディングドキュメントを現在のリポジトリの状態に合わせて更新しない

ベストプラクティス

  1. セットアップ手順は実行可能で、所要時間が明確になるようにします。
  2. 重要なアーキテクチャ上の判断について、その「理由」を記録します。
  3. 動作を変更するPRと同じPRでドキュメントを更新します。
  4. オンボーディングドキュメントは一度限りの成果物ではなく、継続的に更新する運用資産として扱います。

コメント

Markdown 対応