4 ms·
This is a great read and it articulates my own frustration with the current practice-de-jour of "we write such readable code that we don't need documentation".
by swanson 11y ago
This is a great read and it articulates my own frustration with the current practice-de-jour of "we write such readable code that we don't need documentation". While readable code is great, I still don't want to have to read the whole codebase to figure out how to use something.
I've found it useful to take lessons from Kathy Sierra's excellent "BADASS: Making Users Awesome" book. Look, folks, people don't want to use your library because the library itself is awesome - they want to use it to make something awesome for themselves, or to do something that makes them look awesome. Focus on how a new user can use your library/tool to accomplish what they want, not just a laundry list of explaining features.
Apply some of the marketing wisdom and user empathy resources and you will be so far ahead of 90% of the libraries/tools/internal code that exists today.
- aaronbrethorst 11y agoKathy gave a talk at Business of Software a couple years back on the same topic. Well worth an hour of your time: https://vimeo.com/54469442 https://vimeo.com/54469442