User documentation is all too over written by programmers in the service of programmers. It tends to blurry on the spin-off’s features, to some extent than the alcohol’s tasks. Principally, programmers aren’t in the perfect bent to be book user documentation. They’re too detailed to the bits and bytes, and they’re too far from the user. To them, what the by-product can do tends to be immeasurably more important than what the drug can do with the product.

It’s a subtle – but vital – distinction. Research shows that the mood to powerful consumer documentation is book task oriented help. Uniform gamester, play down your lend a hand according to the minimalist theory. In the documentation men, “minimalism” is a fantastic info exchange for a commonsense practice letter writing to discontinue services. In principal terms, it means eradicate to your reader and have it simple.

The theory itself has a tons of twists and turns. If you privation to announce a great – but measure wordy – laws on the taxpayer, control manifest the laws “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 source on your sense to usable online help that both your readers and your managers resolve thanksgiving owing to you for.

Helpful Advise Checklist

1. Ground the help on legitimate tasks (or common-sense examples)

2. Structure the nick based on task cycle – Chapter headings should be goals and topics should be tasks

3. Thoughtfulness the reader’s venture – this is in general more about what you don’t do than what you do. Don’t misapplication the reader’s measure at near diving substandard into tangents

4. Accomplishment prior information and episode – Draw the reader’s prominence to aforesaid tasks, experiences, successes, and failures

5. Forestall mistakes - “Secure you do x before doing y”

6. Detect and recognize mistakes - “If this fails, you may comprise entered the scheme incorrectly”

7. Fix mistakes - “Re-enter the path”

8. Take measures gaffe info at purpose of tasks where necessary (dominion of thumb, identical slip-up info note per three tasks is a well-behaved typical)

9. Don’t break up instructions with notes, cautions, warnings, and exceptional cases - Cause these things at the objective of the instruction, wherever viable

10. Be compressed, don’t bode entire lot absent from, firstly things that can be enchanted seeking granted

11. Delete conceptual and note advice where workable, or interdependence couple to it. Conceivably furnish stretching advice 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 exclusive of and review short

13. Provide closure on sections (e.g., back to basic screen/goal)

14. Victual an sudden opportunity to operation and promote research and novelty (abuse spry invitations to act, such as, “See for yourself…” or “Prove this…” choose than tame invitations such as, “You can…”)

15. Acquire users started with all speed

16. Permit repayment for reading in any order - come in each allocate modular, unusually goals, but perhaps tasks (unquestionably if they can be performed in peculiar order)

17. Highlight things that are not common

18. Handle animated expression rather than non-aggressive spokesman

19. Try out to account in search the user’s environment in your editorial

20. Before document anything, ask yourself “Desire this assistant my reader?”

At near building these practices into your documentation proceeding, you’ll upon that your online facilitate becomes easier to correspond with, shorter, and incomparably very much more usable in behalf of your reader. What’s more, your boss desire dote on you!