ソースコードから設計書を自動生成する

結論

  • ソースコードから、設計書を自動生成します
  • GitHub Actionsを使います
  • Gemini APIの無料枠を使っています
  • 成果物はココ

使い方

  • GitHub ActionsのSECRETを適宜作成します
  • 設計書化したいソースコードを、リポジトリ直下に配置します
  • Actionsの「Update README」を押下
  • Run Workflow > 項目を適宜入力 > Run Workflow を押下
  • 少々お待ちを。
  • 実行完了
  • 設計書が更新されます

デモ用に簡単に作ったものなので、あまり品質は高くないですが、妥協点だと感じます。

プロンプトの書き方や、AIのモデルを工夫すれば、より高品質なアウトプットが期待できます。

さいごに

AWSなどのクラウドサービスを利用していれば、Infrastructure as Codeの導入は簡単です(それ自体もAIに作ってもらえるため)。

となると、インフラ〜アプリまで、ほぼ全ての工程で、設計書を書くという行為は不要になります。

GitHub上でコード管理していれば、自然言語で直接質問できるので、詳細な部分も簡単に把握できます。

もはや、設計書そのものが不要になりそうです。

さらに、コード自体もAIが生成してくれるので、人間様の出番は少なくなりそうですね。