Adopting Elixir

Documentation

We’ve discussed strategies for how to enforce consistent coding standards and typespecs. These are arguably objective metrics. Documentation, on the other hand, is essential to maintaining a consistent codebase, but since it’s for human readers, it’s much more subjective.

For experienced developers, documentation of public and common interfaces allows rapid ramp up and removes friction. For new adopters, documentation is essential. Documentation will help them internalize how your new application works, and serves as a first point of communication between the code producer and consumer. In this section, we’re going to look at ways to help automate aspects of your documentation. We’ll look at tools to help you build tested examples ...