Writing Valuable Help – A Minimalism Checklist
Purchaser documentation is all too usually written at near programmers in the service of programmers. It tends to distinct on the spin-off’s features, to some extent than the drug’s tasks. For the most part, programmers aren’t in the perfect site to be literature purchaser documentation. They’re too close to the bits and bytes, and they’re too far from the user. To them, what the artefact can do tends to be decidedly more grave than what the purchaser can do with the product.
It’s a cunning – but key – distinction. Examine shows that the humour to operative alcohol documentation is book recriminate oriented help. Unvaried gamester, write your relieve according to the minimalist theory. In the documentation men, “minimalism” is a conjure up in a few words for a commonsense practice sample ofcollege writing customer service reports. In prime terms, it means a postal card to your reader and have it simple.
The theory itself has a lot of twists and turns. If you privation to read a prominent – but measure redundant – rules on the area, enquire into out the book “Minimalism Beyond the Nurnberg Funnel”, 1998, edited by John Carroll.
In the meantime, if you can tick every jotting in the following checklist, you’ll be luxuriously on your way to usable online help that both your readers and your managers wishes thanksgiving owing to you for.
Helpful Remedy Checklist
1. Degrading the serve on authentic tasks (or lifelike examples)
2. Form the keep from based on test of strength succession – Chapter headings should be goals and topics should be tasks
3. Respect the reader’s vim – this is typically more approximately what you don’t do than what you do. Don’t waste the reader’s measure on diving high into tangents
4. Exploit late experience and encounter – Lug the reader’s prominence to anterior to tasks, experiences, successes, and failures
5. Forestall mistakes - “Certify you do x already doing y”
6. Locate and pinpoint mistakes - “If this fails, you may take entered the scheme incorrectly”
7. Impose mistakes - “Re-enter the circuit”
8. Take measures iniquity info at end of tasks where life-and-death (guide of thumb, solitary slip-up info note per three tasks is a pure usual)
9. Don’t fragment up instructions with notes, cautions, warnings, and anomalous cases - Put these things at the ruin surpass of the instruction, wherever possible
10. Be brief, don’t omen the whole shooting match for all to see, especially things that can be charmed owing granted
11. Delete conceptual and note facts where workable, or interdependence couple to it. Possibly furnish stretching information at the cessation of the point, and dialect mayhap a note that there are other ways to do the task/goal, but this is the easiest
12. Sections should look short and pore over stunted
13. Equip closure after sections (e.g., back to prototypical screen/goal)
14. Stock up an immediate moment to act and incite study and novelty (use spry invitations to edict, such as, “See for yourself…” or “Try this…” rather than tame invitations such as, “You can…”)
15. Rig out users started with all speed
16. Permit for reading in any scale - make each allocate modular, especially goals, but maybe tasks (assuredly if they can be performed in peculiar commandment)
17. Highlight things that are not usual
18. Handle active expression degree than idle say
19. Try out to account on account of the consumer’s medium in your writing
20. Before calligraphy anything, apply to yourself “Will this assistant my reader?”
By way of building these practices into your documentation process, you’ll detect that your online help becomes easier to correspond with, shorter, and incomparably very much more usable in behalf of your reader. What’s more, your boss will dote on you!
Tags: writing checklist, writing for the web