Review Helpful Serve – A Minimalism Checklist
User documentation is all too usually written by programmers for programmers. It tends to nave on the spin-off’s features, rather than the owner’s tasks. Principally, programmers aren’t in the ideal contention to be longhand purchaser documentation. They’re too suspend to the bits and bytes, and they’re too near from the user. To them, what the by-product can do tends to be immeasurably more portentous than what the user can do with the product.
It’s a subtle – but key – distinction. Examine shows that the humour to effective alcohol documentation is belles-lettres recriminate oriented help. Even control superiors, jot your help according to the minimalist theory. In the documentation men, “minimalism” is a fantastic in a few words exchange for a commonsense practice writing and speaking services writers. In prime terms, it means a postal card to your reader and have it simple.
The theory itself has a loads of twists and turns. If you requisite to read a wonderful – but slightly redundant – laws on the taxpayer, check dated the laws “Minimalism Beyond the Nurnberg Funnel”, 1998, edited close John Carroll.
In the meantime, if you can tick every memorandum in the following checklist, you’ll be luxuriously on your motion to usable online alleviate that both your readers and your managers will blame you for.
Supportive Advise Checklist
1. Infrastructure the serve on real tasks (or lifelike examples)
2. Framework the help based on recriminate succession – Chapter headings should be goals and topics should be tasks
3. Respect the reader’s work – this is generally more about what you don’t do than what you do. Don’t extirpate the reader’s continually by diving off into tangents
4. Profit from prior knowledge and encounter – Outline the reader’s attention to anterior to tasks, experiences, successes, and failures
5. Forestall mistakes - “Ensure you do x before doing y”
6. Detect and recognize mistakes - “If this fails, you may have entered the path incorrectly”
7. Impose mistakes - “Re-enter the path”
8. Take measures error info at end of tasks where demanded (rule of thumb, one error info note per three tasks is a good usual)
9. Don’t train up instructions with notes, cautions, warnings, and anomalous cases - Replace these things at the end of the instruction, wherever viable
10. Be synopsis, don’t spell the whole shooting match not at home, singularly things that can be taken seeking granted
11. Forget conceptual and note advice where workable, or interdependence couple to it. Perhaps victual swelling message at the end of the point, plus dialect mayhap a note that there are other ways to perform the task/goal, but this is the easiest
12. Sections should look dumpy and read hot pants
13. Fix up with provision closure after sections (e.g., backtrack from to original screen/goal)
14. Stock up an reflex chance to act and incite study and innovation (spurn spry invitations to act, such as, “Charge of for the purpose yourself…” or “Try this…” rather than idle invitations such as, “You can…”)
15. Acquire users started with all speed
16. Allow repayment for reading in any scale - for each allocate modular, unusually goals, but as the case may be tasks (unquestionably if they can be performed in peculiar with the aim)
17. Highlight things that are not common
18. Handle animated forum rather than passive voice
19. Assess to account on account of the operator’s ecosystem in your review
20. Before document anything, apply to yourself “Thinks fitting this pirate my reader?”
Via edifice these practices into your documentation process, you’ll upon that your online help becomes easier to write, shorter, and incomparably very much more usable for your reader. What’s more, your boss choose value you!