Tips for writing manuals - 2
Ensure easy information retrieval
- 90% of the time, the user will use the manual to look up information
- And only 10% for informative reading
- So, it must be easy to navigate
- For the user to find what is looked for
- Hence, have a good table of contents
- And keep the descriptions simple!
Use examples
- To illustrate the procedure or instruction
- Whenever possible and appropriate
- One simple example
- Is worth a page of explanation