Exciting ExDoc: save time & reduce risk by enhancing your documentation- Flora Petterson | Code BEAM

CodeSync · June 29, 2025, 1:00pm

This talk was recorded at Code BEAM Europe in October 2024. If you’re curious about our upcoming event, check https://codebebeameurope.com

It’s easy to neglect documentation. But stale, dense, missing or plain wrong documentation can cost hours of frustration at best, and contribute to an unwelcome incident at worst. However, capturing team knowledge in engaging, up-to-date, and complete docs can prevent bugs, save hours of development time, simplify onboarding, shorten PR reviews, improve morale, spot weaknesses in a system, build trust between team members, and even enable a healthy work-life balance.

If we are deep in documentation debt, how do we find the happy place of helpful docs? Fully utilizing ExDoc, a tool to generate documentation for Erlang and Elixir projects, can help you get there. Besides standard tools, ExDoc has added many features that make it easy to improve and maintain your docs. Livebooks, mermaid charts, and custom pages are just a few of the many capabilities.

This talk will walk through before and after examples of how common documentation challenges can be solved using ExDoc.

Comments welcome! View the code-sync tag for more Code Sync talks!