Codebase Documenter

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

使用するべき場面

• 「このコードベースを説明してほしい」
• 「アーキテクチャをドキュメント化してほしい」
• 「このコードはどのように動作するのか」
• 「開発者向けドキュメントを作成してほしい」
• 「コードベースの概要を生成してほしい」
• 「オンボーディングドキュメントを作成してほしい」

ドキュメント化の対象

1. プロジェクト概要

• 目的とビジョン
• ターゲットユーザー
• 主要機能
• 技術スタック
• プロジェクトステータス

2. アーキテクチャ

• 高レベルな構造
• デザインパターン
• データフロー
• 制御フロー
• 図（Mermaid）
• アーキテクチャ上の決定事項

3. ディレクトリ構成

• 組織の目的
• 命名規則
• エントリーポイント
• コアモジュール
• 設定ファイル位置

4. 主要コンポーネント

• メインモジュール
• クラスと関数
• 責務
• 相互作用
• 拡張ポイント
• コード例

5. 外部統合

• 利用するAPI
• データベースとスキーマ
• 認証
• キャッシング
• メッセージキュー
• ファイルストレージ

6. データモデル

• データベーススキーマ
• データ構造
• バリデーション
• マイグレーション
• データ変換

7. 開発環境セットアップ

• 前提条件
• インストール手順
• 設定
• アプリケーション実行
• テスト
• デバッグ
• トラブルシューティング

8. 開発ガイドライン

• コーディング規約
• テストアプローチ
• エラーハンドリング
• ロギング
• セキュリティプラクティス
• パフォーマンスパターン

9. デプロイメント

• ビルドプロセス
• デプロイ手順
• 環境
• モニタリング
• ロールバック手順

10. 貢献方法

• 開発ワークフロー
• コードレビューガイドライン
• テスト要件
• ドキュメント更新

アプローチ

1. Explore agent を使用した調査（詳細）
2. Glob でストラクチャをマッピング
3. 重要なファイルを読み込み（README、エントリーポイント、コアモジュール）
4. Grep でパターンを特定（インポート、エクスポート）
5. 実行パスをトレース
6. ドキュメント、コメント、テストから知識を抽出
7. 統合的なドキュメントに合成

出力

Markdown ドキュメントを作成：

docs/
├── README.md              # 概要とクイックスタート
├── ARCHITECTURE.md        # システムアーキテクチャ
├── DEVELOPMENT.md         # 開発ガイド
├── API.md                 # API ドキュメント
├── DEPLOYMENT.md          # デプロイメントガイド
└── CONTRIBUTING.md        # 貢献ガイドライン

必要に応じて、単一の包括的なドキュメントも作成可能。

詳細度レベル

• クイック：高レベルな概要（15～30 分）
• 標準：包括的なカバレッジ（30～60 分）
• 詳細：例を含む詳細版（60 分以上）

ビジュアル要素

• Mermaid 図（アーキテクチャ、フローチャート、シーケンス図）
• コードベースのコード例
• 特定のファイル:行番号参照
• 構造化情報用テーブル
• ガイドライン用リスト

使用ツール

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

成功基準

• 全領域の完全なカバレッジ
• 例を含むわかりやすい説明
• 複雑な概念のためのビジュアル図
• 特定のファイル:行番号参照
• 実行可能なセットアップ・開発手順
• ドキュメントのみで新規開発者がオンボーディング可能
• 整理された、ナビゲーション可能な構造
• 正確で最新の情報

統合

• code-auditor：品質・セキュリティコンテキストを含む
• project-bootstrapper：ブートストラップの決定事項をドキュメント化
• visual-html-creator：ビジュアル図を作成