設計書をAIが自動作成
— コードから仕様書を生成するツール
エンジニアが手作業で設計書を書く時代は終わりました。RepoCartaはコードを読み取り、アーキテクチャ・DB・API・画面設計書を数分で生成します。
14日Trialで設計書を生成する設計書を手作業で書く問題点
多くの開発チームが設計書の作成・維持に苦労しています。その背景には、手作業による設計書作成が抱える構造的な問題があります。
- 実装後の設計書作成は二重作業になり、多大な工数がかかる
- コードが更新されても設計書が更新されず、情報の乖離が生じる
- 書き手によって記述のレベルや粒度が異なり、品質にばらつきが出る
- ドキュメントの場所が分散し、最新版がどれかわからなくなる
- 退職・異動で担当者が変わると、設計の意図が失われてしまう
これらの問題はすべて、「コードとドキュメントを別々に管理する」という従来のアプローチに起因しています。RepoCartaはコードをドキュメントの唯一のソースとして扱い、この問題を根本から解決します。
RepoCartaが自動生成する設計書の種類
プロジェクトの性質に応じて、以下の設計書を自動生成します。それぞれ実際のコードに基づいた内容で生成されるため、精度の高いドキュメントが得られます。
アーキテクチャ設計書
システム全体の構成・コンポーネント間の依存関係・データフローを図解付きで自動生成します。マイクロサービス構成にも対応。
DB設計書
テーブル定義・カラム一覧・インデックス・リレーションをER図とともに出力します。マイグレーションファイルから正確に生成。
画面設計書
コンポーネントの構造・表示条件・ユーザーアクションを整理した画面仕様書を生成します。React・Vueコンポーネントに対応。
API仕様書
エンドポイント・HTTPメソッド・リクエスト/レスポンスのスキーマ・認証方式を詳細にドキュメント化します。OpenAPI形式で出力可能。
生成された設計書のイメージ
以下は実際にRepoCartaが生成するDB設計書のサンプルです。テーブル構造・カラム定義・制約情報が自動的にMarkdown形式で出力されます。
設計書の自動更新機能
RepoCartaの最大の特徴のひとつが、GitHubへのプッシュに連動した設計書の自動更新機能です。従来の設計書は、コードが更新されても手動で更新する必要があり、結果として陳腐化した不正確なドキュメントが残り続けるという問題がありました。
RepoCartaのWebhook連携を設定すると、メインブランチへのマージのたびに自動でコードが再解析され、設計書が最新の状態に更新されます。更新された箇所はdiffとしてハイライト表示されるため、変更内容を一目で把握できます。
また、週次・月次のスケジュール実行も設定できます。定期的にドキュメントが更新されることで、プロジェクトの現状を常に正確に把握できる環境を維持できます。CIパイプラインに組み込んでPRごとに差分レポートを生成する使い方も人気です。
Webhook連携の設定方法は？
更新頻度に制限はありますか？
料金プラン
まず14日Trialで試して、必要に応じてアップグレードできます。
- 1プロジェクト
- ドキュメント最大3種
- Q&Aチャット
- カード登録不要
- 5プロジェクト
- 全10種のドキュメント
- ドキュメント自動更新
- Q&Aチャット
- 追加パック購入可
Team プランも提供しています。詳細は料金ページをご確認ください。