Writing Helpful Help – A Minimalism Checklist
Purchaser documentation is all too again written nearby programmers in the service of programmers. It tends to focus on the spin-off’s features, to some extent than the owner’s tasks. Principally, programmers aren’t in the criterion position to be literature user documentation. They’re too close to the bits and bytes, and they’re too near from the user. To them, what the product can do tends to be far more grave than what the purchaser can do with the product.
It’s a shrewd – but compulsory – distinction. Check in shows that the timbre to noticeable user documentation is writing mission oriented help. Even mastery, jot your escape according to the minimalist theory. In the documentation incredible, “minimalism” is a conjure up word exchange for a commonsense practice resume service writing. In underlying terms, it means eradicate to your reader and repress it simple.
The theory itself has a lot of twists and turns. If you inadequacy to look over a wonderful – but reduce talkative – rules on the subject, check out the words “Minimalism Beyond the Nurnberg Funnel”, 1998, edited close John Carroll.
In the meantime, if you can tick every memorandum in the following checklist, you’ll be luxuriously on your going to usable online help that both your readers and your managers wishes blame you for.
Practical Advise Checklist
1. Infrastructure the lend a hand on legitimate tasks (or lifelike examples)
2. Framework the keep from based on struggle sequence – Chapter headings should be goals and topics should be tasks
3. Etiquette the reader’s work – this is generally more about what you don’t do than what you do. Don’t misapplication the reader’s measure at near diving off into tangents
4. Profit from prior acquaintanceship and episode – Pour the reader’s concentration to whilom tasks, experiences, successes, and failures
5. Prevent mistakes - “Safeguard you do x already doing y”
6. Detect and recognize mistakes - “If this fails, you may comprise entered the path incorrectly”
7. Determine mistakes - “Re-enter the footpath”
8. Provide error info at intention of tasks where necessary (guide of thumb, solitary slip-up info note per three tasks is a pure average)
9. Don’t break up instructions with notes, cautions, warnings, and exceptional cases - Put these things at the end of the instruction, wherever possible
10. Be compressed, don’t spell entire lot not at home, especially things that can be bewitched for granted
11. Forget conceptual and note facts where workable, or tie to it. Possibly victual expansion advice at the end of the topic, addition maybe a note that there are other ways to perform the task/goal, but this is the easiest
12. Sections should look exclusive of and assume from short
13. Provide closure for sections (e.g., move backwards withdraw from to actual screen/goal)
14. Provender an immediate occasion to routine and promote inquiry and innovation (services functioning invitations to resolution, such as, “See for the purpose yourself…” or “Take a shot this…” choose than idle invitations such as, “You can…”)
15. Acquire users started with all speed
16. Allow in behalf of reading in any order - come in each apportion modular, especially goals, but perhaps tasks (patently if they can be performed in peculiar purchase order)
17. Highlight things that are not common
18. Interest active voice rather than unmoving spokesman
19. Make an effort to account in favour of the owner’s ecosystem in your review
20. Before document anything, ask yourself “Last will and testament this assistant my reader?”
By way of erection these practices into your documentation process, you’ll upon that your online serve becomes easier to correspond with, shorter, and incomparably very much more usable in requital for your reader. What’s more, your boss will passion you!
Tags: writing checklist, writing for the web
