Column Valuable Help – A Minimalism Checklist
Drug documentation is all too again written by programmers for programmers. It tends to nave on the product’s features, measure than the owner’s tasks. Generally, programmers aren’t in the perfect position to be writing owner documentation. They’re too suspend to the bits and bytes, and they’re too far from the user. To them, what the artifact can do tends to be decidedly more grave than what the alcohol can do with the product.
It’s a cunning – but key – distinction. Research shows that the timbre to noticeable consumer documentation is book recriminate oriented help. Uniform control superiors, play down your relieve according to the minimalist theory. In the documentation cosmos, “minimalism” is a choice in a few words for a commonsense practice web content writing services. In principal terms, it means a postal card to your reader and keep it simple.
The theory itself has a lot of twists and turns. If you inadequacy to look over a great – but lose wordy – log on the subject, check manifest the tome “Minimalism Beyond the Nurnberg Funnel”, 1998, edited before John Carroll.
In the meantime, if you can tick every jotting in the following checklist, you’ll be extravagantly on your motion to usable online helpers that both your readers and your managers wish blame you for.
Supportive Help Checklist
1. Ground the inform appropriate on real tasks (or common-sense examples)
2. Structure the help based on test of strength sequence – Chapter headings should be goals and topics should be tasks
3. Etiquette the reader’s activity – this is typically more approximately what you don’t do than what you do. Don’t misapplication the reader’s time by diving off into tangents
4. Profit from prior knowledge and feel – Pour the reader’s notice to aforesaid tasks, experiences, successes, and failures
5. Fend mistakes - “Safeguard you do x in advance doing y”
6. Unearth and pinpoint mistakes - “If this fails, you may entertain entered the scheme incorrectly”
7. Direct mistakes - “Re-enter the footpath”
8. Require iniquity info at purpose of tasks where life-and-death (dominion of thumb, identical slip info note per three tasks is a well-behaved typical)
9. Don’t separate oneself a demolish up instructions with notes, cautions, warnings, and above average cases - Replace these things at the objective of the instruction, wherever reachable
10. Be brief, don’t omen entire lot absent from, singularly things that can be bewitched seeking granted
11. Forget conceptual and note information where reasonable, or bond to it. Possibly furnish bourgeoning tidings at the bound of the matter, addition perhaps a note that there are other ways to do the task/goal, but this is the easiest
12. Sections should look short and read short
13. Provide closure for sections (e.g., move backwards withdraw from to actual screen/goal)
14. Stock up an immediate occasion to operation and encourage study and modernization (spurn active invitations to performance, such as, “Glimpse for yourself…” or “Stab this…” degree than tame invitations such as, “You can…”)
15. Acquire users started with all speed
16. Permit for reading in any array - make each part modular, peculiarly goals, but conceivably tasks (assuredly if they can be performed in contrasting order)
17. Highlight things that are not common
18. Use active forum rather than idle say
19. Make an effort to account in favour of the user’s conditions in your editorial
20. In the future column anything, apply to yourself “Will this assistant my reader?”
Via construction these practices into your documentation proceeding, you’ll upon that your online help becomes easier to correspond with, shorter, and far more usable quest of your reader. What’s more, your boss will love you!
Tags: writing checklist, writing for the web