Abstract

近年、技術の多角化・細分化により、サービス内で使用される技術を俯瞰的に把握することが困難になりました。これに対し、全ての人が俯瞰的に実装を知らずに済む方法としてドキュメントがあります。ドキュメントは実装者以外がリソースを利用する際、あるいは実装者同士の引き継ぎのために使用するものですが、ドキュメント作成に伴う課題の一つにドキュメントと実際のコードの乖離があると考えています。手動による更新は実装者に負担を課すことを意味し、実装者もドキュメントを書かなくなってしまいがちです。このために、コードからドキュメントを生成するための仕組みや、逆にドキュメントからコードを生成する仕組みがあります。 本セッションでは、これらコード生成・ドキュメント生成のツールの例を示しながら両者の長所を考えつつ、これらツールの効率的・効果的な運用方法について考察していきます。