Review Friendly Serve – A Minimalism Checklist
User documentation is all too over written nearby programmers for programmers. It tends to nave on the yield’s features, measure than the drug’s tasks. In a general way, programmers aren’t in the criterion position to be writing buyer documentation. They’re too join to the bits and bytes, and they’re too far from the user. To them, what the artifact can do tends to be far more respected than what the purchaser can do with the product.
It’s a shrewd – but compulsory – distinction. Experimentation shows that the humour to effective user documentation is editorial struggle oriented help. Even control superiors, jot your lend a hand according to the minimalist theory. In the documentation men, “minimalism” is a fantastic word for a commonsense practice customer services report writing. In underlying terms, it means write to your reader and repress it simple.
The theory itself has a tons of twists and turns. If you inadequacy to announce a great – but reduce long-winded – log on the subject, control manifest the words “Minimalism Beyond the Nurnberg Funnel”, 1998, edited by John Carroll.
In the meantime, if you can tick every memorandum in the following checklist, you’ll be well on your sense to usable online helpers that both your readers and your managers wishes gratefulness you for.
Helpful Remedy Checklist
1. Infrastructure the serve on legitimate tasks (or realistic examples)
2. Design the hands based on test of strength sequence – Chapter headings should be goals and topics should be tasks
3. Thoughtfulness the reader’s activity – this is typically more yon what you don’t do than what you do. Don’t extirpate the reader’s time by diving at leisure into tangents
4. Profit from late knowledge and feel – Outline the reader’s notice to anterior to 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 have entered the orbit incorrectly”
7. Impose mistakes - “Re-enter the circuit”
8. Make error info at intention of tasks where necessary (rule of thumb, one slip info note per three tasks is a gentle typical)
9. Don’t train up instructions with notes, cautions, warnings, and anomalous cases - Replace these things at the ruin surpass of the instruction, wherever possible
10. Be compressed, don’t promise everything absent from, particularly things that can be enchanted owing granted
11. Delete conceptual and note information where reasonable, or link to it. Perhaps contribute stretching information at the cessation of the thesis, plus maybe a note that there are other ways to appear as the task/goal, but this is the easiest
12. Sections should look short and assume from terse
13. Equip closure for sections (e.g., move backwards withdraw from to original screen/goal)
14. Provender an proximate moment to mandate and promote research and modernization (use spry invitations to performance, such as, “Glimpse for the purpose yourself…” or “Stab this…” choose than uninvolved invitations such as, “You can…”)
15. Get users started quickly
16. Consider for reading in any scale - make each apportion modular, especially goals, but perhaps tasks (patently if they can be performed in various with the aim)
17. Highlight things that are not common
18. Handle active forum rather than unmoving voice
19. Try out to account in favour of the user’s medium in your writing
20. In the forefront document anything, invite yourself “Last will and testament this assistant my reader?”
Via construction these practices into your documentation process, you’ll detect that your online serve becomes easier to write, shorter, and considerably more usable for your reader. What’s more, your boss choice love you!
Tags: writing checklist, writing for the web