やりなおし

claudeにtools\reg_system\project_analyzer.pyを作らせた

プロジェクト構造解析ツール - クイックガイド¶

🎯 何ができるか？¶

Before（手動でドキュメント作成）¶

😰 新しいプロジェクトに参加
   ↓
📁 ディレクトリを1つずつ開いて確認
   ↓
📝 手動でドキュメントを作成
   ↓
⏰ 数時間〜数日かかる
   ↓
😓 古くなったらまた更新作業

After（このツールを使用）¶

😊 新しいプロジェクトに参加
   ↓
⚡ python project_analyzer.py
   ↓
⏱️ 1-3分で完了
   ↓
📊 階層的なドキュメントが自動生成
   ↓
✅ いつでも再実行で最新化

🚀 クイックスタート（30秒）¶

1. 準備（初回のみ）¶

# 1. 必要なパッケージをインストール
pip install requests python-dotenv

# 2. .envファイルにAPIキーを設定
echo "GOOGLE_API_KEY=your_key_here" > .env

2. 実行¶

# プロジェクトルートで実行
python project_analyzer.py

3. 確認¶

# 生成されたドキュメントを確認
code docs/project_analysis/PROJECT_OVERVIEW.md

これだけ！

📊 生成されるもの¶

docs/project_analysis/
├── PROJECT_OVERVIEW.md          ← プロジェクト全体の概要
├── README.md                     ← ルートディレクトリの説明
├── tools/
│   └── README.md                 ← tools/の説明
├── src/
│   └── README.md                 ← src/の説明
└── config/
    └── README.md                 ← config/の説明

各ドキュメントの内容:

• 📋 概要（このディレクトリの役割）
• 🎯 目的（なぜ存在するか）
• 📂 構成（主要ファイルの説明）
• 🔍 詳細（技術的な説明）
• 💡 理解のポイント

🧠 クレバーな機能¶

1. 自動除外¶

.venv/          ← スキップ
node_modules/   ← スキップ
__pycache__/    ← スキップ
.git/           ← スキップ
src/            ← ✅ 解析
tools/          ← ✅ 解析

メリット: 無駄な処理を自動で省く

2. 重要度判定¶

README.md           ← Critical（必ず解析）
requirements.txt    ← Critical（必ず解析）
main.py            ← High（優先的に解析）
utils.py           ← Medium（選択的に解析）
test_*.py          ← Low（深い階層では除外）

メリット: 重要な部分に集中

3. API最適化¶

1ディレクトリあたり最大5ファイル
↓
API呼び出し回数を削減
↓
実行時間を短縮
↓
コストを削減

メリット: 速くて安い

💡 使い分け¶

パターン1: プロジェクト全体を理解したい¶

# デフォルト設定で実行
python project_analyzer.py

こんな時に:

• 新しいプロジェクトに参加した
• プロジェクト構造の全体像を知りたい
• チームメンバーにプロジェクトを説明したい

パターン2: 特定のディレクトリを詳しく¶

# toolsディレクトリのみを深く解析
cd tools
python /path/to/project_analyzer.py . --depth 5

こんな時に:

• 特定のモジュールを深く理解したい
• サブプロジェクトを独立して解析したい

パターン3: 浅く広く¶

# トップレベルのみ
python project_analyzer.py --depth 1

こんな時に:

• プロジェクトの大枠だけ知りたい
• 実行時間を短縮したい

📈 実行例¶

小規模プロジェクト（Djangoアプリ）¶

$ python project_analyzer.py

======================================================================
🔍 プロジェクト解析ツール
======================================================================
プロジェクトルート: /home/user/my_django_app
出力先: docs/project_analysis
最大深度: 3
======================================================================

📊 ステップ1: プロジェクト構造をスキャン中...

📈 スキャン結果:
  - 総ディレクトリ数: 8
  - 総ファイル数: 47
  - スキップ: 23ファイル

📝 ステップ2: プロジェクト概要を生成...
✅ プロジェクト概要を生成: docs/project_analysis/PROJECT_OVERVIEW.md

🔍 ステップ3: ディレクトリ解析を開始...

📁 root/
   重要度: critical
   ファイル数: 5
   🔍 解析対象: 3ファイル
      - README.md (critical)
      - requirements.txt (critical)
      - manage.py (high)
   ✅ ドキュメント生成: README.md

  📁 my_app/
     重要度: high
     ファイル数: 12
     🔍 解析対象: 5ファイル
        - models.py (high)
        - views.py (high)
        - urls.py (high)
        - admin.py (medium)
        - apps.py (medium)
     ✅ ドキュメント生成: my_app/README.md

======================================================================
✅ 解析完了!
======================================================================
📊 統計情報:
  - 解析ディレクトリ数: 5
  - 解析ファイル数: 18
  - API呼び出し回数: 6
  - 実行時間: 42.3秒

📁 出力先: docs/project_analysis
======================================================================

⚙️ オプション一覧¶

# 基本
python project_analyzer.py

# 特定のディレクトリ
python project_analyzer.py /path/to/project

# 深度指定
python project_analyzer.py --depth 5

# 出力先指定
python project_analyzer.py -o custom_output/

# すべて組み合わせ
python project_analyzer.py /path/to/project --depth 4 -o docs/analysis/

🎁 生成されるドキュメントのサンプル¶

PROJECT_OVERVIEW.md の例¶

# プロジェクト概要

## 📝 プロジェクト名
keinasystem02 - 米農家向け販売管理システム

## 🎯 目的
農家が直接運営する米販売ECサイトのバックエンドシステム。
顧客管理、注文処理、在庫管理を統合的に行う。

## 🏗️ アーキテクチャ概要
- バックエンド: Django 4.2 + PostgreSQL
- インフラ: Docker + Traefik
- ドキュメント: Trilium Notes連携

## 📂 ディレクトリ構造
- riceshop/: Djangoメインアプリケーション
- tools/: 開発・運用ツール
- docs/: プロジェクトドキュメント
- config/: 設定ファイル

## 💻 技術スタック
- Python 3.12
- Django 4.2
- PostgreSQL 15
- Docker
- Gemini API（ドキュメント生成）

## 📌 注目ポイント
- カスタム認証システム（日本語対応）
- Trilium Notesとの自動同期
- AI活用のドキュメント自動生成

tools/README.md の例¶

# tools/

## 📋 概要
開発・運用を効率化するPythonスクリプト群。
ドキュメント生成、バックアップ、Trilium同期など。

## 🎯 目的
手作業を自動化し、開発者の生産性を向上させる。

## 📂 構成
### 主要ファイル
- doc_generator.py: Gemini APIを使ったドキュメント自動生成
- project_analyzer.py: プロジェクト構造解析
- sync_trilium_smart.py: Trilium Notes同期ツール

### サブディレクトリ
- py_system/: 共通ユーティリティ

## 🔍 詳細
このディレクトリのツールは、以下の3つの領域をカバー：
1. ドキュメント生成（doc_generator.py, project_analyzer.py）
2. データ同期（sync_trilium_smart.py）
3. 共通機能（py_system/）

各ツールは独立して動作し、.env経由でAPI Keyを管理。

## 💡 理解のポイント
1. すべてのツールがGemini APIを活用
2. .gitignoreで.envを除外してセキュリティ確保
3. モジュール化されており、個別に実行可能
4. エラーハンドリングを強化して信頼性向上
5. 詳細なドキュメント自動生成で保守性確保

🆚 他の方法との比較¶

手動でREADMEを書く¶

メリット:

• コストゼロ
• 自由な表現

デメリット:

• ❌ 時間がかかる（数時間〜数日）
• ❌ 古くなる
• ❌ 人によって品質がバラバラ
• ❌ 大規模プロジェクトでは現実的でない

tree コマンド¶

tree -L 3 -I 'node_modules|.venv'

メリット:

• 高速
• シンプル

デメリット:

• ❌ ディレクトリ構造だけ
• ❌ 説明がない
• ❌ 重要度が分からない

このツール¶

メリット:

• ✅ 自動生成（1-3分）
• ✅ 常に最新
• ✅ 重要度を自動判定
• ✅ 詳細な説明付き
• ✅ 階層的なドキュメント

デメリット:

• API Key が必要
• 実行に時間がかかる（1-5分）

💰 コスト¶

Gemini API（無料枠）¶

• 1分間: 60リクエスト
• 1日: 1,500リクエスト

実際の使用例¶

• 小規模プロジェクト: 5-10リクエスト → 無料
• 中規模プロジェクト: 10-20リクエスト → 無料
• 大規模プロジェクト: 20-40リクエスト → 無料

結論: ほとんどの場合、無料枠内で利用可能

🎓 学習曲線¶

1日目:   基本的な実行方法を理解
         ↓
2-3日目: オプションを使いこなす
         ↓
1週間:   カスタマイズ方法を習得
         ↓
2週間:   チーム全体で活用

学習コスト: 低い

まとめ¶

このツールが向いている人¶

✅ 新しいプロジェクトに頻繁に参加する人
✅ 大規模プロジェクトを扱う人
✅ ドキュメント作成が面倒な人
✅ チームでプロジェクト構造を共有したい人

このツールが向いていない場面¶

❌ 極小規模プロジェクト（5ファイル未満）
❌ API Keyを取得できない環境
❌ オフライン環境

推奨ワークフロー¶

# 1. プロジェクトクローン
git clone https://github.com/user/project.git
cd project

# 2. プロジェクト解析（まず全体を把握）
python /path/to/project_analyzer.py

# 3. ドキュメント確認
code docs/project_analysis/PROJECT_OVERVIEW.md

# 4. 必要に応じて個別ディレクトリを深掘り
cd src/important_module
python /path/to/project_analyzer.py . --depth 5

# 5. 開発開始！

これで、どんなプロジェクトも素早く理解できます！