Effective Software Documentation with Everett Griffiths - EMx 180 Elixir Mix

Bad documentation wastes time, costs real money, and makes developers unproductive.  Documentation might be bad because it is flat-out wrong (typos, references to an older version, etc.), but more often documentation is bad when it fails to tell us what we need to know.  Don’t let all your hard work go to waste because you failed to communicate what your software is or how to use it.  Today on the show, Everett Griffiths shares his insights on how to approach documentation simply and effectively.

In this episode…
What got you into documentation?  Examples, examples, examplesHaving an effective feedback loopKey word argumentsCoding is easy, but documentation is hardUsing mermaid chartsOpen sourcing your softwareClean code and clean infrastructure Simplifying coding environments 
SponsorsTop End DevsCoaching | Top End Devs
LinksWTFM: Writing Effective Software DocumentationInspecting Ecto Schemas with Elixir | by Everett Griffiths | Medium 1Enhancing Elixir Documentation with Mermaid Charts | by Everett Griffiths | Medium 1Coding is Easy; Communication is Hard | by Everett Griffiths | Medium 1LinkedIn: Everett GriffithsTwitter: @fireproofsocks
PicksAdi- Grafana OnCallAllen- MJML - The Responsive Email FrameworkEverett- Paasaa - Paasaa v0.6.0Everett- The Guns of August: The Pulitzer Prize-Winning Classic About the Outbreak of World War I

Advertising Inquiries: https://redcircle.com/brands

Privacy & Opt-Out: https://redcircle.com/privacy

Become a supporter of this podcast: https://www.spreaker.com/podcast/elixir-mix--6102049/support.