脱二重メンテナンス!ドキュメント自動生成への道 by 進藤 遼

JJUG CCC 2022 Spring
採択
2022/06/19 15:00〜
Track D (#jjug_ccc_d)
Video:15min + Live:10min
StepUp Beginner Method Youtube公開予定 メディア取材可

脱二重メンテナンス!ドキュメント自動生成への道

shindo_ryo 進藤 遼 shindo_ryo
13

プレゼンタイプ / Presentation Type [StepUp]:
レベル / Level [Beginner]:
カテゴリー / Categories [Method]:
後日セッション動画の公開を希望する / Agree to publish your session video [Yes]:
メディア取材可否 / Can you respond to the interview? [Yes]:

概要 / Abstract:
ソフトウェア開発では様々なドキュメントを作成します。しかし多くの開発者がドキュメントに苦い思い出をお持ちかと思います。統一されないフォーマット、ソースコードとの乖離、バラバラの置き場所…
特にドキュメントとソースコードの乖離という課題に対して、ドキュメントからソースコードの生成、ソースコードからドキュメントの自動生成というアプローチがありますが、十分に使いこなせていないと感じる方もいるかもしれません。
このセッションでは、Spring Bootアプリケーションを題材に、OpenAPI、SchemaSpyなどを使った各種ドキュメントを"実際に動くもの"から生成する方法を紹介し、ドキュメント自動生成との現実的な付き合い方について考えていきます。