自動コードドキュメント生成を行うLLMエージェント設計論

本記事では、コードドキュメントを自動生成するLLMエージェント設計に関する研究を紹介します。
複雑なコードベースに対応するため、エージェント間で役割を分担し、依存関係を踏まえた段階的な処理を行うアプローチが提案されています。
あわせて、生成されたドキュメントを多面的に評価するための指標設計についても検討されています。
ドキュメント自動化を目指す際に参考となる設計上の考え方を整理していきます。

背景

ソフトウェア開発において、コードのドキュメントは欠かせない存在です。コードの理解や保守を支えるだけでなく、LLMを使ったコード解析や生成の精度にも大きく関わってきます。

ただ実際には、ドキュメント作成と管理は手間がかかり、多くの開発現場で品質や量にばらつきが出ています。

この課題を受けて、近年では自動生成に取り組む動きが活発になっています。チャット型エージェントなどでコードの周辺情報をもとにドキュメントを補完する仕組みが開発されてきました。

GitHubリポジトリをURLを差し替えるだけでWiki形式に可視化し、依存関係図やチャットUIまで提供するDeepWikiのようなツールも登場しました。こちらは初見リポジトリを素早く把握するには便利です。

ただ、商用ツールはSaaSとしての操作性や体験に主眼が置かれており、内部構造や評価手法については詳細が公表されていません。

ビジネスとしては、プライベートリポジトリや巨大なモノリスコードにも対応できる方法が望まれています。

こうした背景を受け、Metaの研究チームからは、コード全体をトップダウンで順序立てて処理し、ドキュメントを自動生成しながら品質を多面的に評価する新しい手法が提案されています。