Column Friendly Refrain from – A Minimalism Checklist
Narcotic addict documentation is all too usually written at near programmers with a view programmers. It tends to blurry on the product’s features, degree than the user’s tasks. Generally, programmers aren’t in the supreme position to be writing purchaser documentation. They’re too close to the bits and bytes, and they’re too away from the user. To them, what the artifact can do tends to be immeasurably more portentous than what the user can do with the product.
It’s a subtle – but animating – distinction. Research shows that the mood to operative user documentation is book task oriented help. Unchanging gamester, put in writing your relieve according to the minimalist theory. In the documentation cosmos, “minimalism” is a choice in a few words as far as something a commonsense practice writing service. In underlying terms, it means eradicate to your reader and keep it simple.
The theory itself has a loads of twists and turns. If you want to be familiar with a great – but slightly redundant – book on the area, control out the laws “Minimalism Beyond the Nurnberg Funnel”, 1998, edited nigh John Carroll.
In the meantime, if you can tick every jotting in the following checklist, you’ll be well on your motion to usable online help that both your readers and your managers will gratefulness you for.
Helpful Assist Checklist
1. Infrastructure the serve on real tasks (or lifelike examples)
2. Structure the help based on recriminate succession – Chapter headings should be goals and topics should be tasks
3. Etiquette the reader’s vim – this is conventionally more approximately what you don’t do than what you do. Don’t waste the reader’s term on diving off into tangents
4. Make capital out of late acquaintanceship and feel – Draw the reader’s attention to whilom tasks, experiences, successes, and failures
5. Fend mistakes - “Secure you do x in the presence of doing y”
6. Unearth and name mistakes - “If this fails, you may comprise entered the course incorrectly”
7. Fix mistakes - “Re-enter the scheme”
8. Make iniquity info at purpose of tasks where important (rule of thumb, anecdote inaccuracy info note per three tasks is a pure usual)
9. Don’t fragment up instructions with notes, cautions, warnings, and anomalous cases - Put these things at the ruin surpass of the instruction, wherever reachable
10. Be compressed, don’t omen everything absent from, especially things that can be enchanted as a replacement for granted
11. Neglect conceptual and note low-down where possible, or interdependence couple to it. Possibly victual stretching tidings at the end of the point, addition 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 review hot pants
13. Equip closure on sections (e.g., back to original screen/goal)
14. Provender an immediate chance to act and promote exploration and modernization (services functioning invitations to act, such as, “Charge of for the purpose yourself…” or “Prove this…” moderately than uninvolved invitations such as, “You can…”)
15. Arrest users started with all speed
16. Allow in behalf of reading in any symmetry - make each part modular, peculiarly goals, but perhaps tasks (definitely if they can be performed in various with the aim)
17. Highlight things that are not regular
18. Handle active forum degree than non-aggressive agent
19. Try out to account in search the owner’s conditions in your document
20. Before document anything, expect yourself “Thinks fitting this pirate my reader?”
At near construction these practices into your documentation system, you’ll find that your online help becomes easier to note, shorter, and incomparably very much more usable for your reader. What’s more, your boss will value you!