Need documentation usability tips? Are you a creator of product documentation? Let us have a look at some ways to produce documents that are easy – and satisfying – to use.
Consumers rarely read product documentation. Why? Because people are inherently lazy. Why read some manual unless we have to?
And, when someone must read product documentation, it is customarily due to a usability issue with the product itself. So, it makes sense that the documentation is easy-to-use. Otherwise, the product owner will be doubly frustrated.
So, to enhance the usability of your documentation, here are some tips:
Whole document -
- be concise: use as few words as possible to make your point
- chunk information: break up data into small bite-size, digestable chunks
- use a succinct table of contents generated from the level 1, 2 and 3 headings you use in your document
- provide an index thoroughly cross-referenced by keywords – preferably matching keywords actually being used in google searches
- make it a downloadable PDF with live links within the document
Individual pages -
- be concise: have someone edit your draft document; it is customary for 75% of wording to be unnecessary!
- use page numbering so users can easily go from table of contents or index straight to the page they need
- follow the page-numbering format “Page x of xx” so users can determine their location within the document
- use images and screenshots to appeal to those who follow graphics better than words
- recruit 5 representative users for a simple usability test of your document; results always astound and inform
Those are just a few documentation usability tips. Can you think of more? Your feedback is encouraged. Please comment below.
If you enjoyed this post, make sure you subscribe to my RSS feed!
