divar-ir/ai-doc-gen

解決する課題

コードベースの進化に伴い、正確なコードドキュメントを維持することは絶え間ない課題です。このツールは、包括的なREADMEファイルとAIアシスタント設定ファイルの作成と更新を自動化し、手動の作業なしにドキュメントを最新の状態に保ちます。

仕組み

このシステムは、pydantic-aiによって駆動されるマルチエージェントアーキテクチャを使用しています。5つの特化した分析エージェントが並行して実行され、コードベースの構造、依存関係、データフロー、リクエストフロー、およびAPIをマッピングします。これらのエージェントは、分析結果を .ai/docs/ に保存します。その後、生成エージェントがこれらの分析結果を使用して、洗練された README.md や CLAUDE.md、AGENTS.md、CursorルールなどのAI専用設定ファイルを生成します。

対象者

ドキュメントワークフローの自動化を求める開発者やエンジニアリングチーム、特にAIコーディングアシスタント（Claude CodeやCursorなど）を使用している方、およびcronjobを介してGitLabと連携し、自動化された定期更新を行いたい方に適しています。

ハイライト

• マルチエージェント分析: 5つの特化したエージェントを使用して、さまざまな次元からコードベースのディープな分析を実行します。
• AIアシスタントの最適化: AIコーディングアシスタントのパフォーマンスを向上させるための、特定のルールや設定ファイルを生成します。
• GitLab統合: アクティブなプロジェクトを自動的に検出し、更新されたドキュメントを含むマージリクエストを作成するcronjobモードが含まれています。
• 柔軟なLLMサポート: すべてのOpenAI互換APIに対応しており、さまざまなモデルやプロバイダーを使用できます。
• Claude Codeプラグイン: プラグインとしてインストールすることで、Claude Code環境内で直接 analyze-codebase、generate-readme、generate-ai-rules スキルを提供できます。