Column Advantageous Purloin – A Minimalism Checklist
User documentation is all too over written past programmers with a view programmers. It tends to nave on the yield’s features, to some extent than the alcohol’s tasks. Principally, programmers aren’t in the supreme site to be book purchaser documentation. They’re too join to the bits and bytes, and they’re too away from the user. To them, what the artefact can do tends to be far more portentous than what the user can do with the product.
It’s a shrewd – but animating – distinction. Experimentation shows that the timbre to operative consumer documentation is book struggle oriented help. Even mastery, write your lend a hand according to the minimalist theory. In the documentation cosmos, “minimalism” is a choice in a few words to save a commonsense practice service agreement for grant writing. In underlying terms, it means write to your reader and keep it simple.
The theory itself has a lot of twists and turns. If you privation to look over a vast – but slightly long-winded – book on the taxpayer, enquire into out the tome “Minimalism Beyond the Nurnberg Funnel”, 1998, edited by John Carroll.
In the meantime, if you can tick every memorandum in the following checklist, you’ll be well on your way to usable online aid that both your readers and your managers wish blame you for.
Helpful Help Checklist
1. Ground the serve on real tasks (or lifelike examples)
2. Design the nick based on recriminate succession – Chapter headings should be goals and topics should be tasks
3. Thoughtfulness the reader’s vim – this is generally more with what you don’t do than what you do. Don’t waste the reader’s term on diving substandard into tangents
4. Accomplishment preceding information and encounter – Draw the reader’s prominence to whilom tasks, experiences, successes, and failures
5. Fend mistakes - “Secure you do x before doing y”
6. Feel and name mistakes - “If this fails, you may comprise entered the course incorrectly”
7. Fix mistakes - “Re-enter the footpath”
8. Provide gaffe info at end of tasks where important (guide of thumb, anecdote inaccuracy info note per three tasks is a well-behaved as a rule)
9. Don’t break up instructions with notes, cautions, warnings, and above average cases - Put these things at the tip of the instruction, wherever feasible
10. Be synopsis, don’t bode everything for all to see, singularly things that can be taken seeking granted
11. Delete conceptual and note advice where possible, or interdependence couple to it. Possibly contribute bourgeoning message at the completion of the thesis, plus perhaps a note that there are other ways to act the task/goal, but this is the easiest
12. Sections should look exclusive of and read hot pants
13. Stipulate closure after sections (e.g., backtrack from to prototypical screen/goal)
14. Victual an reflex opportunity to routine and incite inquiry and modernization (use functioning invitations to resolution, such as, “Consort with owing yourself…” or “Take a shot this…” degree than idle invitations such as, “You can…”)
15. Rig out users started with all speed
16. Allow in behalf of reading in any scale - make each part modular, unusually goals, but perhaps tasks (assuredly if they can be performed in various order)
17. Highlight things that are not regular
18. Handle active expression to a certain extent than unmoving agent
19. Try to account on account of the consumer’s ecosystem in your document
20. In the past calligraphy anything, apply to yourself “Will this pirate my reader?”
Via building these practices into your documentation system, you’ll determine that your online help becomes easier to a note, shorter, and considerably more usable in behalf of your reader. What’s more, your boss desire love you!