Column Advantageous Purloin – A Minimalism Checklist
User documentation is all too usually written nearby programmers in place of programmers. It tends to nave on the product’s features, to some extent than the alcohol’s tasks. Principally, programmers aren’t in the criterion position to be longhand buyer documentation. They’re too join to the bits and bytes, and they’re too far from the user. To them, what the by-product can do tends to be decidedly more grave than what the alcohol can do with the product.
It’s a concealed – but compulsory – distinction. Experimentation shows that the timbre to noticeable user documentation is belles-lettres recriminate oriented help. Even mastery, write your help according to the minimalist theory. In the documentation men, “minimalism” is a conjure up info for a commonsense practice college writing customer service reports samples. In basic terms, it means catalogue to your reader and repress it simple.
The theory itself has a lot of twists and turns. If you privation to look over a great – but slightly redundant – laws on the area, control out the tome “Minimalism Beyond the Nurnberg Funnel”, 1998, edited by John Carroll.
In the meantime, if you can tick every note in the following checklist, you’ll be luxuriously on your way to usable online aid that both your readers and your managers will gratefulness you for.
Helpful Help Checklist
1. Infrastructure the help on real tasks (or common-sense examples)
2. Design the hands based on struggle arrangement – Chapter headings should be goals and topics should be tasks
3. Respect the reader’s activity – this is conventionally more with what you don’t do than what you do. Don’t waste the reader’s continually at near diving high into tangents
4. Exploit late acquaintanceship and feel – Pour the reader’s attention to whilom tasks, experiences, successes, and failures
5. Prevent mistakes - “Certify you do x in the presence of doing y”
6. Unearth and pinpoint mistakes - “If this fails, you may take entered the orbit incorrectly”
7. Determine mistakes - “Re-enter the path”
8. Require error info at purpose of tasks where demanded (guide of thumb, anecdote inaccuracy info note per three tasks is a gentle average)
9. Don’t break up instructions with notes, cautions, warnings, and handicapped cases - Cause these things at the objective of the instruction, wherever feasible
10. Be compressed, don’t omen everything absent from, especially things that can be taken owing granted
11. Forget conceptual and note advice where realizable, or bond to it. Perhaps contribute stretching information at the end of the thesis, and peradventure a note that there are other ways to act the task/goal, but this is the easiest
12. Sections should look to make a long story short and read stunted
13. Equip closure for sections (e.g., back to actual screen/goal)
14. Victual an proximate opportunity to act and promote study and innovation (services spry invitations to resolution, such as, “See for yourself…” or “Try this…” degree than tame invitations such as, “You can…”)
15. Acquire users started with all speed
16. Entertain repayment for reading in any array - come in each allocate modular, especially goals, but maybe tasks (assuredly if they can be performed in different commandment)
17. Highlight things that are not regular
18. Eat animated expression to a certain extent than passive agent
19. Assess to account for the user’s ecosystem in your review
20. In the forefront document anything, ask yourself “Desire this assistant my reader?”
Via erection these practices into your documentation proceeding, you’ll determine that your online help becomes easier to a note, shorter, and considerably more usable in requital for your reader. What’s more, your boss choose love you!
Tags: writing checklist, writing for the web