Posts

Showing posts with the label Reference

Documentation Is More Than Reference

Image
“ Great documentation builds trust, differentiates you from your competition, and provides marketing value . ” Here, Diana is talking about the good stuff, the stuff that you actually enjoy reading, that you can rely on, and that you might actually extol. (Yes, it exists!  Stripe’s docs  are a great example). /via http://geek-and-poke.com/ Unfortunately, in most of our world, documentation is one of those things that is frequently an afterthought. Or worse, left to the  #TechBros . “The code is the documentation”  — #CowboyDeveloper Documenting  what  the code does can be remarkably useful for somebody modifying the code, but  is close to useless for somebody that wants to use the system, and doesn’t give a s**t about the underlying code . The Components Product documentation should have three clear components • Concepts : An introduction to the system, that provides an understanding of its overall purpose , the ideas and concepts emb...