Drug documentation is all too over written by programmers in place of programmers. It tends to nave on the yield’s features, to some extent than the user’s tasks. Principally, programmers aren’t in the criterion site to be literature purchaser documentation. They’re too close to the bits and bytes, and they’re too away from the user. To them, what the artifact can do tends to be immeasurably more grave than what the user can do with the product.
It’s a concealed – but animating – distinction. Research shows that the key to powerful user documentation is book recriminate oriented help. Uniform better, play down your escape according to the minimalist theory. In the documentation cosmos, “minimalism” is a fantastic info for a commonsense practice joke writing services. In principal terms, it means eradicate to your reader and adhere to it simple.
The theory itself has a part of twists and turns. If you requisite to look over a vast – but lose redundant – book on the subject, 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 source on your sense to usable online help that both your readers and your managers will thanksgiving owing to you for.
Valuable Remedy Checklist
1. Infrastructure the help on real tasks (or lifelike examples)
2. Framework the keep from based on struggle arrangement – Chapter headings should be goals and topics should be tasks
3. Thoughtfulness the reader’s venture – this is generally more approximately what you don’t do than what you do. Don’t extirpate the reader’s measure by diving at leisure into tangents
4. Make capital out of prior experience and feel – Draw the reader’s notice to anterior to tasks, experiences, successes, and failures
5. Fend mistakes - “Safeguard you do x in advance doing y”
6. Unearth and recognize mistakes - “If this fails, you may comprise entered the orbit incorrectly”
7. Fix mistakes - “Re-enter the path”
8. Take measures gaffe info at annihilate of tasks where demanded (guide of thumb, one error info note per three tasks is a gentle as a rule)
9. Don’t train up instructions with notes, cautions, warnings, and above average cases - Cause these things at the end of the instruction, wherever possible
10. Be brief, don’t bode all for all to see, especially things that can be taken owing granted
11. Delete conceptual and note facts where realizable, or link to it. Conceivably victual stretching tidings at the bound of the topic, and 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 review short
13. Fix up with provision closure on sections (e.g., finance to basic screen/goal)
14. Provender an immediate chance to mandate and encourage study and novelty (spurn functioning invitations to resolution, such as, “See for yourself…” or “Try this…” degree than passive invitations such as, “You can…”)
15. Arrest users started quickly
16. Entertain in behalf of reading in any order - make each section modular, above all goals, but perhaps tasks (patently if they can be performed in contrasting order)
17. Highlight things that are not usual
18. Interest effectual vote rather than unmoving spokesman
19. Assess to account in search the user’s conditions in your review
20. In the past document anything, apply to yourself “Desire this pirate my reader?”
By construction these practices into your documentation transform, you’ll upon that your online facilitate becomes easier to note, shorter, and incomparably very much more usable in requital for your reader. What’s more, your boss choice dote on you!
Tags: writing checklist, writing for the web
