mcpField
C
codebase-documenter

codebase-documenter

github.com/mhattingpete開発689591 回インストール14 週間前に更新
リポジトリ

codebase-documenter について

codebase-documenterは、コードベースからアーキテクチャやコンポーネント、セットアップ、デプロイを扱う開発者向けドキュメントを作成するスキルです。リポジトリの調査手順を示し、複数のMarkdownファイルまたは包括的な単一文書を出力します。

主な機能

  1. 01アーキテクチャとデータフローの文書化
  2. 02ディレクトリとコンポーネントの説明
  3. 03セットアップと開発のガイド
  4. 04デプロイとコントリビューションの項目
  5. 05Mermaid図とコード例
  6. 06クイック、標準、詳細の範囲

活用シーン

  1. 01オンボーディング文書の準備
  2. 02不慣れなコードベースの解説
  3. 03アーキテクチャとデータフローの記録
  4. 04開発・デプロイガイドの作成

インストール

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

$npx skills add https://github.com/mhattingpete/claude-skills-marketplace --skill codebase-documenter

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

詳細

コードベースのドキュメント作成

コードベースの包括的なドキュメントを生成します。アーキテクチャ、コンポーネント、データフロー、開発ガイドラインを網羅します。

使用する場面

  • 「このコードベースについて説明して」
  • 「アーキテクチャをドキュメント化して」
  • 「このコードの仕組みを教えて」
  • 「開発者向けドキュメントを作成して」
  • 「コードベースの概要を生成して」
  • 「オンボーディング用ドキュメントを作成して」

ドキュメント化する内容

1. プロジェクト概要
  • 目的とビジョン
  • 対象ユーザー
  • 主な機能
  • 技術スタック
  • プロジェクトの状況
2. アーキテクチャ
  • 全体構造
  • 設計パターン
  • データフロー
  • 制御フロー
  • 図（Mermaid）
  • アーキテクチャ上の決定事項
3. ディレクトリ構成
  • ディレクトリの用途
  • 命名規則
  • エントリーポイント
  • コアモジュール
  • 設定ファイルの場所
4. 主要コンポーネント
  • 主要モジュール
  • クラスと関数
  • 責務
  • 相互作用
  • 拡張ポイント
  • コード例
5. 外部連携
  • 利用する API
  • データベースとスキーマ
  • 認証
  • キャッシュ
  • メッセージキュー
  • ファイルストレージ
6. データモデル
  • データベーススキーマ
  • データ構造
  • 検証
  • マイグレーション
  • データ変換
7. 開発環境のセットアップ
  • 前提条件
  • インストール手順
  • 設定
  • アプリの実行
  • テスト
  • デバッグ
  • トラブルシューティング
8. 開発ガイドライン
  • コーディング規約
  • テスト方針
  • エラー処理
  • ロギング
  • セキュリティ対策
  • パフォーマンスのパターン
9. デプロイ
  • ビルドプロセス
  • デプロイ手順
  • 環境
  • モニタリング
  • ロールバック手順
10. コントリビューション
  • 開発ワークフロー
  • コードレビューのガイドライン
  • テスト要件
  • ドキュメントの更新

アプローチ

  1. Explore エージェントを使って徹底的に調査する
  2. Glob で構成を把握する
  3. 重要なファイル（README、エントリーポイント、コアモジュール）を読む
  4. Grep でパターンを特定する（インポート、エクスポート）
  5. 実行パスを追跡する
  6. ドキュメント、コメント、テストから情報を抽出する
  7. 内容を統合し、一貫性のあるドキュメントにまとめる

出力

Markdown ドキュメントを作成します。

docs/
├── README.md              # Overview and quick start
├── ARCHITECTURE.md        # System architecture
├── DEVELOPMENT.md         # Development guide
├── API.md                 # API documentation
├── DEPLOYMENT.md          # Deployment guide
└── CONTRIBUTING.md        # Contribution guidelines

希望に応じて、包括的なドキュメントを1つ作成することもできます。

詳細レベル

  • クイック：概要（15～30分）
  • 標準：包括的な内容（30～60分）
  • 詳細：例を含む徹底的な内容（60分以上）

視覚要素

  • Mermaid 図（アーキテクチャ、フローチャート、シーケンス図）
  • コードベースからのコード例
  • ファイル名と行番号を指定した参照
  • 構造化された情報を示す表
  • ガイドラインを示すリスト

使用するツール

  • Task（Explore エージェント）：コードベースの調査
  • Glob：ディレクトリ構成の把握
  • Grep：パターン、インポート、エクスポートの検索
  • Read：重要なファイルの分析
  • Write：ドキュメントの作成
  • Bash：メタデータの抽出（git log、バージョン）

成功基準

  • すべての領域を網羅している
  • 例を交えた分かりやすい説明
  • 複雑な概念を示す視覚的な図
  • ファイル名と行番号を指定した参照
  • 実行可能なセットアップおよび開発手順
  • 新しい開発者がドキュメントだけでオンボーディングできる
  • 整理され、見つけやすい構成
  • 正確で最新の情報

統合

  • code-auditor：品質とセキュリティに関する情報を含める
  • project-bootstrapper：ブートストラップに関する決定事項をドキュメント化する
  • visual-html-creator：視覚的な図を作成する

コメント

Markdown 対応