Posts tagged docs

Documentation is JSON for the Brain

When you are writing software, you build a mental model of the program in your brain. This is how you make decisions and reason about how the program might work, how data flows, or what designs make the most sense.

Read more ...


"My Code is Self-Documenting"

Self-documenting code is one of the biggest documentation myths in the software industry. This view generally conflates documentation with code comments. I’d like to make two arguments in this post:

Read more ...


A Selfish Appeal for Documentation

Writing code is the act of building a mental model of a problem, and then translating that model into executable software.

Read more ...




Hey there. I'm Eric and I do consulting and provide other services around software documentation. Feel free to email me if you want to chat.