Get the latest tech news
Teach, Don't Tell (2013)
Posted on September 3rd, 2013. This post is about writing technical documentation.
The mother smiles and says: "You're in luck, honey, my friend Jim works here at the Chevy plant, and he's gonna let you watch a few crash tests of the new Malibu! When you tell them how to play a C major chord on the guitar and they only produce a strangled squeak, it's clear that you need to slow down and talk about how to press down on the strings properly. Programmers are pretty good at skimming over things they already know, but if you forget to include a crucial connection it can leave your users lost and stumbling around in the woods.
Or read this on Hacker News