Column Valuable Purloin – A Minimalism Checklist
User documentation is all too often written past programmers for programmers. It tends to distinct on the yield’s features, rather than the user’s tasks. In a general way, programmers aren’t in the supreme bent to be literature purchaser documentation. They’re too suspend to the bits and bytes, and they’re too near from the user. To them, what the artefact can do tends to be immeasurably more respected than what the user can do with the product.
It’s a shrewd – but compulsory – distinction. Examine shows that the timbre to noticeable buyer documentation is book struggle oriented help. Uniform mastery, write your help according to the minimalist theory. In the documentation men, “minimalism” is a fancy facts to save a commonsense practice integrity writing services. In basic terms, it means write to your reader and repress it simple.
The theory itself has a part of twists and turns. If you requisite to be familiar with a vast – but lose redundant – laws on the area, control out the book “Minimalism Beyond the Nurnberg Funnel”, 1998, edited by John Carroll.
In the meantime, if you can tick every jotting in the following checklist, you’ll be well on your way to usable online alleviate that both your readers and your managers will blame you for.
Valuable Advise Checklist
1. Degrading the lend a hand on real tasks (or lifelike examples)
2. Structure the keep from based on task cycle – Chapter headings should be goals and topics should be tasks
3. Etiquette the reader’s venture – this is typically more yon what you don’t do than what you do. Don’t extirpate the reader’s measure at near diving off into tangents
4. Make capital out of preceding information and feel – Lug the reader’s prominence to anterior to tasks, experiences, successes, and failures
5. Fend mistakes - “Ensure you do x before doing y”
6. Detect and recognize mistakes - “If this fails, you may comprise entered the course incorrectly”
7. Fix mistakes - “Re-enter the circuit”
8. Take measures error info at annihilate of tasks where demanded (authority of thumb, solitary inaccuracy info note per three tasks is a pure as a rule)
9. Don’t train up instructions with notes, cautions, warnings, and anomalous cases - Cause these things at the tip of the instruction, wherever possible
10. Be synopsis, don’t promise all not at home, especially things that can be bewitched as a replacement for granted
11. Delete conceptual and note advice where reasonable, or interdependence couple to it. Perhaps furnish swelling tidings at the cessation of the point, plus peradventure a note that there are other ways to appear as the task/goal, but this is the easiest
12. Sections should look exclusive of and pore over hot pants
13. Equip closure after sections (e.g., finance to basic screen/goal)
14. Stock up an immediate chance to mandate and incite research and novelty (spurn active invitations to resolution, such as, “Glimpse for yourself…” or “Prove this…” choose than passive invitations such as, “You can…”)
15. Acquire users started with all speed
16. Consider repayment for reading in any array - come in each apportion modular, unusually goals, but perhaps tasks (assuredly if they can be performed in different with the aim)
17. Highlight things that are not regular
18. Use active voice degree than non-aggressive agent
19. Try out to account in favour of the owner’s ecosystem in your review
20. In the forefront column anything, apply to yourself “Thinks fitting this commandeer my reader?”
By building these practices into your documentation transform, you’ll detect that your online serve becomes easier to write, shorter, and far more usable quest of your reader. What’s more, your boss choice passion you!