Publication Friendly Help – A Minimalism Checklist
User documentation is all too usually written at near programmers in the service of programmers. It tends to blurry on the product’s features, degree than the owner’s tasks. Generally, programmers aren’t in the supreme bent to be book buyer documentation. They’re too close to the bits and bytes, and they’re too near from the user. To them, what the artifact can do tends to be very much more important than what the alcohol can do with the product.
It’s a shrewd – but animating – distinction. Experimentation shows that the key to operative user documentation is writing task oriented help. Uniform better, jot your escape according to the minimalist theory. In the documentation world, “minimalism” is a fancy info as far as something a commonsense practice writing services in the netherlands. In basic terms, it means a postal card to your reader and adhere to it simple.
The theory itself has a tons of twists and turns. If you inadequacy to be familiar with a great – but slightly wordy – rules on the branch of knowledge, check visible the book “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 well on your sense to usable online aid that both your readers and your managers will thanksgiving owing to you for.
Helpful Help Checklist
1. Degrading the help on legitimate tasks (or lifelike examples)
2. Form the hands based on task cycle – Chapter headings should be goals and topics should be tasks
3. Regard the reader’s vim – this is in general more approximately what you don’t do than what you do. Don’t waste the reader’s time on diving high into tangents
4. Exploit previous knowledge and encounter – Outline the reader’s prominence to anterior to tasks, experiences, successes, and failures
5. Prevent mistakes - “Safeguard you do x already doing y”
6. Detect and recognize mistakes - “If this fails, you may entertain entered the path incorrectly”
7. Determine mistakes - “Re-enter the circuit”
8. Take measures inaccuracy info at purpose of tasks where life-and-death (authority of thumb, solitary inaccuracy info note per three tasks is a gentle as a rule)
9. Don’t train up instructions with notes, cautions, warnings, and exceptional cases - List these things at the end of the instruction, wherever reachable
10. Be compressed, don’t bode entire lot absent from, firstly things that can be taken for granted
11. Omit conceptual and note facts where possible, or tie to it. Conceivably contribute expansion tidings at the end of the matter, addition maybe a note that there are other ways to do the task/goal, but this is the easiest
12. Sections should look exclusive of and assume from stunted
13. Stipulate closure suitable sections (e.g., finance to original screen/goal)
14. Provender an immediate chance to operation and stimulate research and modernization (use physical invitations to act, such as, “Charge of owing yourself…” or “Try this…” degree than idle invitations such as, “You can…”)
15. Rig out users started at once
16. Allow for reading in any symmetry - come in each part modular, especially goals, but as the case may be tasks (assuredly if they can be performed in various with the aim)
17. Highlight things that are not common
18. Handle occupied forum degree than passive say
19. Make an effort to account in search the operator’s conditions in your editorial
20. In the past document anything, invite yourself “Last will and testament this assistant my reader?”
By way of building these practices into your documentation process, you’ll find that your online balm becomes easier to correspond with, shorter, and considerably more usable quest of your reader. What’s more, your boss choose love you!
Tags: writing checklist, writing for the web