explain-codebase について
コードを変更せず、指定されたコードベースの領域を調べて説明するリポジトリスキルです。開発者がエントリーポイント、モジュール、呼び出し元、データフローを追跡し、根拠と推論、不明点を分けて把握できます。
主な機能
- 01リポジトリの指示と関連ドキュメントの確認
- 02対象範囲とエントリーポイントの特定
- 03モジュール、呼び出し元、テスト、データフローの追跡
- 04根拠、推論、不明点の区別
- 05関連ファイルを絞った説明
活用シーン
- 01不慣れなコード領域の把握
- 02リポジトリ内のリクエストやデータの流れの追跡
- 03現行コードや関連ADRに基づく設計判断の理解
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/explain-codebaseを入力して読み込まれたか確認します。
同梱ファイルagents/openai.yamlskill.toml
詳細
コードベースの説明
コードを変更せずに、指定されたコード領域をマッピングします。
手順
- リポジトリの指示と、関連する最新のドキュメント、用語集、ADR を読みます。
- ユーザーが範囲を指定していない場合は、役に立つ最小限の範囲を推定します。
- エントリーポイント、主要モジュール、呼び出し元、テスト、および重要なデータフロー／制御フローを調べます。
- 履歴を参照する前に、関連する ADR を読みます。ユーザーから求められた場合、または現時点の根拠では重要な設計上の選択を説明できない場合に限り、対象を絞って履歴を調べます。
- ユーザーの理解度に合わせて責務とフローを説明し、確認済みの根拠、推論、不明点を区別します。
簡潔にまとめる場合は、次の構成を優先します。
- 目的
- エントリーポイントと主要モジュール
- 呼び出し／データ／制御のフロー
- 関連するテストまたはチェック
- 重要な用語
- 不明点または前提
検索結果を羅列するのではなく、対象を絞ったファイル参照を使います。ユーザーが別のワークフローに切り替えない限り、編集、診断、レビュー、リファクタリングは行いません。根拠からバグの可能性やアーキテクチャ上の摩擦が見つかった場合は、簡潔に指摘し、別の次のステップとして diagnose-issue または improve-architecture を提案します。
コメント
Markdown 対応