ドキュメントって書きたいけど、書けないですよね。
機能開発が忙しい、仕様が変わってすぐ陳腐化する、そもそも書くコストが高すぎる——結果として「コードを読んでください」になりがちです。
この記事では、GitHubリポジトリに接続するだけでAIがドキュメントを自動生成・自動更新してくれる RepoCarta の使い方を紹介します。
この記事でわかること
GitHubリポジトリから仕様書・設計書を自動生成するには、GitHub Appで対象リポジトリを接続し、AIがコードを解析してドキュメントを作成するサービスを使うのが最短です。
RepoCartaでは、アーキテクチャ設計書・API仕様書・DB設計書など10種類のドキュメントを数分で生成できます。pushやPRマージ後はWebhookを受け取り、変更差分に合わせてドキュメント更新PRを作成します。
RepoCartaとは
GitHubリポジトリのソースコードをAIが読んで、以下の10種類のドキュメントを自動生成するSaaSです。
| カテゴリ | 種別 |
|---|---|
| 設計 | アーキテクチャ設計書、API仕様書、DB設計書、画面設計書 |
| 開発 | 環境構築手順、運用手順書、開発ガイド、トラブルシューティング |
| テスト・レビュー | テストケース、課題・改善リスト |
生成後はドキュメントに対してQ&Aチャットもできます。「この認証はどこで実装してる？」「このAPIのレート制限は？」といった質問に、コードとドキュメントを根拠に答えます。
pushするたびに自動更新されるので、ドキュメントがコードと乖離しません。
使い方
1. GitHubアカウントでログイン
https://app.repocarta.jp にアクセスして、GitHubアカウントでログインします。
2. GitHub Appをインストール
対象リポジトリへのアクセスを許可するため、RepoCarta GitHub Appをインストールします。特定のリポジトリだけに絞ることも可能です。
3. プロジェクトを作成
「新しいプロジェクト」からリポジトリを選択します。
4. 生成するドキュメントを選択
10種類の中から必要なものだけ選びます。小規模なOSSなら「アーキテクチャ設計書」「環境構築手順」「開発ガイド」あたりが特に有用です。
5. 生成を待つ
AIがソースコードを解析して数分でドキュメントを生成します。
6. 以降は自動更新
pushやPRマージのタイミングでWebhookを受け取り、差分を分析してドキュメントを自動更新します。更新内容はPRとして作成されるので、内容を確認してからマージできます。
Q&Aチャットの使い方
生成されたドキュメントをベースに質問できます。
- 「認証フローはどこに実装されている？」
- 「データベースのマイグレーション手順は？」
- 「このエンドポイントのレスポンス形式は？」
ベクトル検索でドキュメントから関連箇所を取得し、AIが根拠付きで回答します。
料金
| プラン | 価格 | プロジェクト数 | ドキュメント種別 |
|---|---|---|---|
| Free | ¥0 | 1件 | 最大3種 |
| Solo | ¥4,980（税込）/月 | 5件 | 全10種 |
まずFreeプランで試してみてください。