Title:
Writing Helpful Help A Minimalism Checklist
Word Count:
560
Summary:
User documentation is all too often written by programmers for programmers. It tends to focus on the products features, rather than the users tasks. Generally, programmers arent in the ideal position to be writing user documentation. Theyre too close to the bits and bytes, and theyre too far from the user. To them, what the product can do tends to be far more important than what the user can do with the product.
Keywords:
writing checklist, writing for the web
Article Body:
User documentation is all too often written by programmers for programmers. It tends to focus on the products features, rather than the users tasks. Generally, programmers arent in the ideal position to be writing user documentation. Theyre too close to the bits and bytes, and theyre too far from the user. To them, what the product can do tends to be far more important than what the user can do with the product.
Its a subtle but vital distinction. Research shows that the key to effective user documentation is writing task oriented help. Even better, write your help according to the minimalist theory. In the documentation world, minimalism is a fancy word for a commonsense practice. In basic terms, it means write to your reader and keep it simple.
The theory itself has a lot of twists and turns. If you want to read a great but slightly wordy book on the subject, check out the book Minimalism Beyond the Nurnberg Funnel, 1998, edited by John Carroll.
In the meantime, if you can tick every item in the following checklist, youll be well on your way to usable online help that both your readers and your managers will thank you for.
Helpful Help Checklist
- Base the help on real tasks (or realistic examples)
- Structure the help based on task sequence Chapter headings should be goals and topics should be tasks
- Respect the reader's activity this is generally more about what you dont do than what you do. In the event you cherished this article as well as you would like to obtain guidance concerning informasi generously visit our own web-page. Dont waste the readers time by diving off into tangents
- Exploit prior knowledge and experience Draw the readers attention to previous tasks, experiences, successes, and failures
- Prevent mistakes - "Ensure you do x before doing y"
- Detect and identify mistakes - "If this fails, you may have entered the path incorrectly"
- Fix mistakes - "Re-enter the path"
- Provide error komersial info at end of tasks where necessary (rule of thumb, one error info note per three tasks is a good average)
- Don't break up instructions with notes, cautions, warnings, and exceptional cases - Put these things at the end of the instruction, wherever possible
- Be brief, don't spell everything out, especially things that can be taken for granted
- Omit conceptual and note information where possible, or link to it. Perhaps provide expansion information at the end of the topic, plus maybe a note that there are other ways to perform the task/goal, but this is the easiest
- Sections should look short and read short
- Provide closure for sections (e.g., back to original screen/goal)
- Provide an immediate opportunity to act and encourage exploration and innovation (use active invitations to act, such as, "See for yourself..." or "Try this..." rather than passive invitations such as, "You can...")
- Get users started quickly
- Allow for reading in any order - make each section modular, especially goals, but perhaps tasks (definitely if they can be performed in different order)
- Highlight things that are not typical
- Use active voice rather than passive voice
- Try to account for the user's environment in your writing
- Before writing anything, ask yourself Will this help my reader?