Mermaid x AST x 生成AI = コードとドキュメントの完全同期への道

DMM.go #9 における渋谷の発表スライド。
ビジネスロジックのドキュメント化の課題と解決策について語りました。
Go言語のAST解析を活用し、ChatGPTと組み合わせることで、ビジネスロジックをMermaid形式のフローチャートとして自動生成するプロセスを開発。
試行錯誤を経て、if文やfor文を含むロジックを正確に視覚化する仕組みを実現しました。
将来的にはCIに組み込み、コードとドキュメントを完全同期させる仕組みを目指します。
本取り組みの成果と今後の展望をご紹介します。

Transcript

1. © DMM.com Mermaid x AST x 生成AI = コードとドキュメントの 完全同期への道 合同会社DMM.com データ基盤開発部 渋谷　瑞穂
2. © DMM.com 目次 序章: はじめまして。ドキュメントで悩んでいませんか？ 第一章: 理解が進めば、開発も進む。ドキュメント化の可能性 第二章: 手書きでは届かない、その先へ。生成AIで挑む 第三章: 切り札登場。AST × o1-previewで限界突破 第四章: 9割の成功と1割の壁。その先にあるもの 最終章: CIで実現する、完全同期への道
3. © DMM.com 序章: はじめまして。ドキュメントで悩んでいませんか？ 名前：渋谷　瑞穂 （しぶや　みずほ） 所属：合同会社DMM.com データ基盤開発部 業務：DMMサービス横断データ活用システムの開発運用保守 経歴：Webエンジニア (Java)　＞　情シスエンジニア (Java) 　　　＞　モバイルバックエンドエンジニア (Python・AWS) 　　　＞　現職 (Go・Google Cloud) 趣味：刀剣乱舞、3DCG、ツール開発、ちまちました手仕事 主義：手を抜く手間は惜しまない
4. © DMM.com 第一章: 理解が進めば、開発も進む。ドキュメント化の可能性 ドキュメントを元にコードを作成 検証 仕様変更をコードに反映 仕様変更をドキュメントに反映させる暇がない…
5. © DMM.com 第二章: 手書きでは届かない、その先へ。生成AIで挑む Mermaid: 　簡潔なテキスト記述でフローチャートやシーケンス図、 　ガントチャートなどの視覚的な図表を書ける書式 https://mermaid.js.org/intro/
6. © DMM.com 第二章: 手書きでは届かない、その先へ。生成AIで挑む https://www.youtube.com/watch?v=6PT8jnGTOx4&t=2470s 「単体テストのスケルトンコードを自動生成するツールを作った話」(n9te9) ？
7. © DMM.com 第三章: 切り札登場。AST × o1-previewで限界突破 GoのASTパッケージを利用して、入力したロジックコードを 解析して、ロジックのフローチャートをMermaid式で出力 するGoコードを書きたいです ステップバイステップで落ち着いて考えてください 入力コード例 　[社外に出しても問題ないよう抽象化したgoコード] 出力mermaid例 　[期待するMermaid式]
8. © DMM.com 第四章: 9割の成功と1割の壁。その先にあるもの 1. ダブルクォーテーションなど特殊な記号のエスケープ 処理が出来ていなかった 2. if - else の分岐後のチャートのラインがうまく引けて なかった →　ChatGPTの追加プロンプトで解決 3. コード前後のコメントをMermaidに組み込みたい 4. ファイルの入出力処理 →　手動で解決
9. © DMM.com 第四章: 9割の成功と1割の壁。その先にあるもの 1. ダブルクォーテーションなどのエスケープ処理
10. © DMM.com 第四章: 9割の成功と1割の壁。その先にあるもの 2. if - else の分岐後のチャートのラインがうまく引けなかった
11. © DMM.com 第四章: 9割の成功と1割の壁。その先にあるもの 3. コード前後のコメントをMermaidに組み込みたい
12. © DMM.com 第四章: 9割の成功と1割の壁。その先にあるもの 最初 ChatGPTで解決できたと ころまで 最終
13. © DMM.com 最終章: CIで実現する、完全同期への道 ドキュメントを元にコードを作成 検証 仕様変更を コードに反映 コードからドキュメントを再生成
14. © DMM.com 次回予告 2024/12/23 DMM Developers Blog にて詳細公開予定 https://developersblog.dmm.com/
15. © DMM.com ご清聴ありがとうございました
16. © DMM.com Appendix
17. © DMM.com Appendix
18. © DMM.com Appendix
19. © DMM.com Appendix
20. © DMM.com Appendix
21. © DMM.com Appendix
22. © DMM.com Appendix
23. © DMM.com Appendix
24. © DMM.com Appendix
25. © DMM.com Appendix
26. © DMM.com Appendix
27. © DMM.com Appendix
28. © DMM.com Appendix
29. © DMM.com Appendix
30. © DMM.com Appendix
31. © DMM.com Appendix
32. © DMM.com Appendix
33. © DMM.com Appendix