What nobody tells you about documentation
This article starts out like a bit of false advertising: It doesn’t matter how good your software is, because if the documentation is not good enough, people will not use it. People tell us that about documentation all the time. Come on, now. Get to the good stuff! In this article I will explain how you can make your documentation better, not by working harder at it, but by doing it the right way. The right way is the easier way - easier to write, and easier to maintain. OK, I’m listening. I’m listening. Documentation needs to include and be structured around its four different functions: tutorials, how-to guides, explanation and technical reference. Each of them requires a distinct mode of writing. Pay dirt! 🙌 This is an absolute must-read on the four different kinds of docs and how to effectively execute on each.
read more
