リポジトリのREADMEやAPI仕様書を「書いた」覚えはあっても、「最新の状態に保ち続けた」経験はあまりない。コードは毎日変わるが、ドキュメントは最初の一度きりのままになりがちだ。
AIを使えばドキュメントを自動生成できる。ただし一口に「自動生成」と言っても、ツールによって対象(README限定か設計書まで含むか)、操作方法(手動実行かpush連動か)、プライベートリポジトリへの対応が大きく異なる。
試した4つを整理した。
DeepWiki
Cognition LabsがDevin(AIソフトウェアエンジニア)の付属機能として公開。GitHubのURLを貼るだけでリポジトリ全体のWikiを生成する。アーキテクチャ図の自動生成とリポジトリへのQ&Aが特徴。
- パブリックリポジトリ:無料
- プライベートリポジトリ:Devinのサブスクリプションが必要
- 更新方式:手動(URLを入力するたびに生成)
「今このリポジトリを理解したい」に強い。外部OSSの構造把握や、初見コードベースを読み解くのに使うのが本来の目的に近い。継続的なドキュメント管理用途には設計されていない。
readme-ai
CLIツール(eli64s/readme-ai)。pip install readmeaiで導入して、リポジトリのパスやURLを渡すとREADMEを生成する。OpenAI・Anthropic・Gemini・Ollamaを選んで使えるため、ローカルLLMで完全オフライン動作も可能。
- 料金:ツール自体は無料(LLM API費用は別途)
- プライベートリポジトリ:ローカル実行なので対応可能
- 更新方式:コマンド実行のたびに生成
生成対象はREADMEに特化。テンプレートとバッジの種類が豊富で、見た目にこだわったREADMEを1回作りたいOSS開発者向け。API仕様書や設計書の生成は対象外。
GitHub Copilot
IDE内のコーディングアシスタントとして使う。コードを書きながらdocstringやコメントをその場で生成する形がメイン。リポジトリ単位でのドキュメント生成機能も追加されている。
- 料金:$10/月〜
- プライベートリポジトリ:対応
- 更新方式:IDE操作(自動ではない)
コーディングとドキュメントを同時に進めたい用途に向く。ただしドキュメント専用ツールと比べると出力の網羅性は下がる。コードの意図をその場でコメントに落とす使い方が現実的。
RepoCarta
GitHub Appとして接続して、pushやPR mergeをトリガーに自動でドキュメントを再生成する。README・API仕様書・アーキテクチャ概要など複数のドキュメントタイプを一括管理。
- 料金:¥5,500/月〜
- プライベートリポジトリ:対応
- 更新方式:push/PR mergeごとに自動
比較まとめ
| DeepWiki | readme-ai | GitHub Copilot | RepoCarta | |
|---|---|---|---|---|
| 対象ドキュメント | Wikiページ全般 | README | 主にdocstring | README・仕様書等 |
| プライベートリポジトリ | 有料サブスク | ローカル実行で可 | ◎ | ◎ |
| 更新方式 | 手動 | 手動 | 手動 | 自動(push連動) |
| 日本語対応 | △ | ○ | ○ | ◎ |
| 料金感 | 無料(パブリック) | 無料 | $10/月〜 | ¥5,500/月〜 |
何を選ぶか
外部OSSの構造をすぐ把握したい → DeepWiki(URLを貼るだけ)
自分のOSSのREADMEを一度きれいに仕上げたい → readme-ai(CLIで柔軟に生成)
コーディングしながらドキュメントも同時に書きたい → GitHub Copilot
プライベートリポジトリのドキュメントをコードに追従させ続けたい → RepoCarta
「一度生成して終わり」か「コードに追従し続けるか」で選ぶ軸が変わる。手動実行ツールを選んでも、更新のたびにコマンドを叩く習慣がなければ結局ドキュメントは腐る。継続更新が必要なら仕組みで解決するしかない。
自分のプロジェクトで継続更新が必要になって作ったのが RepoCarta です。同じ課題を感じている方はぜひ。