楽しいドキュメンテーションを目指して—RDoc拡張機能基盤 by おおくらまさふみ

BuriKaigi 2025
採択
レギュラートーク(30分)

楽しいドキュメンテーションを目指して—RDoc拡張機能基盤

okuramasafumi おおくらまさふみ okuramasafumi
1

プログラミング言語にはドキュメンテーションの仕組みがあります。Rubyには標準添付ライブラリとしてRDocというツールと記法が存在しますが、広く使われているのは標準ではないYARDというツール及び記法であるなどエコシステムが統一されていません。
そこで私は今、標準添付であるRDocに各種ツールを統合するための基盤整備を行っています。具体的にはRDocに拡張機能の仕組みを導入することで、将来的なドキュメンテーションへの要求にRDocのみで応えられるようになることを目指します。このプロジェクトは2024年度Rubyアソシエーション開発助成にも採択されています。
このトークではRDoc拡張機能基盤プロジェクトの概要とこれまでの進捗を説明し、さらにRubyにおける「たのしいドキュメンテーション」という最終目標に関連したいくつかの計画についてお話できればと思います。