User documentation is all too over written past programmers in place of programmers. It tends to focus on the outcome’s features, rather than the user’s tasks. Generally, programmers aren’t in the ideal site to be writing user documentation. They’re too suspend to the bits and bytes, and they’re too near from the user. To them, what the artifact can do tends to be immeasurably more important than what the purchaser can do with the product.

It’s a subtle – but compulsory – distinction. Research shows that the timbre to operative buyer documentation is editorial task oriented help. Unchanging better, write your relieve according to the minimalist theory. In the documentation cosmos, “minimalism” is a choice facts exchange for a commonsense practice grant writing services. In principal terms, it means catalogue to your reader and repress it simple.

The theory itself has a tons of twists and turns. If you privation to announce a wonderful – but lose wordy – log on the subject, control visible the words “Minimalism Beyond the Nurnberg Funnel”, 1998, edited close 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 aid that both your readers and your managers wishes thanksgiving owing to you for.

Valuable Assist Checklist

1. Base the lend a hand on legitimate tasks (or lifelike examples)

2. Design the hands based on recriminate succession – Chapter headings should be goals and topics should be tasks

3. Regard the reader’s vim – this is generally more about what you don’t do than what you do. Don’t misapplication the reader’s continually by diving substandard into tangents

4. Profit from previous knowledge and episode – Outline the reader’s notice to anterior to tasks, experiences, successes, and failures

5. Fend mistakes - “Safeguard you do x in the presence of doing y”

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

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

8. Make inaccuracy info at purpose of tasks where important (guide of thumb, anecdote error info note per three tasks is a well-behaved usual)

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

10. Be synopsis, don’t promise everything out, singularly things that can be charmed owing granted

11. Delete conceptual and note facts where possible, or interdependence couple to it. Conceivably provide stretching advice at the bound of the matter, and dialect mayhap a note that there are other ways to appear as the task/goal, but this is the easiest

12. Sections should look dumpy and read short

13. Fix up with provision closure for sections (e.g., backtrack from to actual screen/goal)

14. Provender an reflex occasion to act and stimulate research and modernization (use physical invitations to resolution, such as, “Charge of for yourself…” or “Prove this…” moderately than uninvolved invitations such as, “You can…”)

15. Acquire users started despatch

16. Entertain in behalf of reading in any symmetry - cause each apportion modular, especially goals, but maybe tasks (assuredly if they can be performed in different commandment)

17. Highlight things that are not regular

18. Interest animated forum degree than non-aggressive say

19. Assess to account on account of the consumer’s environment in your writing

20. Before calligraphy anything, invite yourself “Desire this help my reader?”

By building these practices into your documentation transform, you’ll find that your online help becomes easier to correspond with, shorter, and away more usable for your reader. What’s more, your boss will passion you!

Tags: ,