FSoft-AI4Code/CodeWiki

解決する課題

CodeWiki は、大規模なコードベース向けの包括的なリポジトリレベルのドキュメント作成を自動化します。数千行から数百万行に及ぶ、複数のプログラミング言語にわたるプロジェクトにおいて、アーキテクチャ概要やモジュール説明を手動で書く手間を排除します。

仕組み

このツールはリポジトリを分析して依存関係グラフを構築し、それをモジュールの階層ツリーに分割します。AIエージェントが再帰的に展開されます。リーフモジュールのエージェントはコードに基づいて個別のページを作成し、親モジュールのエージェントはこれらの子ページを統合して高レベルの概要を作成します。また、Dockerfile や CI ワークフローなどの非コード成果物もグラフに組み込み、ビルドやデプロイのプロセスを文書化します。システムは増分更新をサポートしており、コード変更後に影響を受けるモジュールのみを修正し、ドキュメントセット全体を再生成する必要はありません。

対象読者

大規模プロジェクトのソフトウェアエンジニア、アーキテクト、メンテナーで、手動でのメンテナンスの手間なく、最新の高レベルなドキュメントを必要とする方。

ハイライト

• 多言語サポート: Python、Java、C++、Rust、TypeScript を含む11言語に対応。
• 階層分解: 依存関係グラフを管理可能なモジュールツリーにクラスタリングすることで、100万行規模のリポジトリにも対応。
• 成果物認識: コードとともに、ビルドファイル、パッケージマニフェスト、設定スキーマを文書化。
• 増分更新: 特定のコードコミットの影響を受けるページのみを更新することで、コストと時間を削減。
• IDE統合: Cursor や Claude Desktop などの AI IDE で使用するための MCP サーバーを提供。
• 多言語出力: さまざまな言語（例: 日本語、ベトナム語）でドキュメントを生成可能。