← 一覧へ
🔍 コードを理解するCC / Codex 両対応難易度: 中級
コードベース理解サポート acquire-codebase-knowledge
新しいプロジェクトも怖くない！コードの全体像をスッキリ整理
これは何？
これは、新しいプロジェクトに参加した時や既存のコードベースを理解する時に役立つツールです。コードを分析して、プロジェクトの技術スタックやアーキテクチャ、テスト方法など7種類のドキュメントを自動的に作成します。コードの全体像を短時間で把握できるので、開発効率がアップします。
これでできること
- プロジェクトで使われている技術スタック(STACK.md)を自動的に整理できる
- ディレクトリ構造(STRUCTURE.md)を視覚的に理解できる
- システムのアーキテクチャ(ARCHITECTURE.md)を明確にできる
- コーディング規約(CONVENTIONS.md)をまとめられる
- 外部連携(INTEGRATIONS.md)のポイントを把握できる
- テスト方法(TESTING.md)と懸念事項(CONCERNS.md)を整理できる
こんな時に便利
新しいプロジェクトに参加した時
長期間触っていなかったコードベースを再確認する時
チームメンバーにコードベースを説明する資料が必要な時
プロジェクトの技術負債を把握したい時
コードレビューの前に全体像を理解したい時
使い方
プロジェクトのルートディレクトリでスキャンスクリプトを実行するだけで、7種類のドキュメントが自動生成されます。特定の部分だけ知りたい時は「アーキテクチャだけ教えて」などと指定することも可能です。生成されたドキュメントは随時更新できます。
使用例（こう頼んでみよう）
このコードベースの全体像をマッピングしてプロジェクトのアーキテクチャだけドキュメント化して新しく参加したので、このリポジトリの構造を教えてテスト方法と懸念事項についてまとめて必要なもの
- 特になし
導入方法
いちばん簡単（AIに頼む）
次のスキルを入れて: https://github.com/github/awesome-copilot/tree/main/skills/acquire-codebase-knowledge手動で置く
Claude Code →
~/.claude/skills/acquire-codebase-knowledge/Codex →
~/.agents/skills/acquire-codebase-knowledge/使いこなしのコツ
- 生成されたドキュメントはあくまでコードから読み取れる事実のみを記載しています。必要に応じてチームメンバーに確認しましょう
- モノレポの場合は各ワークスペースごとに分析するとより正確です
- READMEに書かれている内容と実際のコードが異なる場合があるので、必ずコードを確認しましょう