Column Valuable Purloin – A Minimalism Checklist
User documentation is all too over written past programmers in place of programmers. It tends to blurry on the yield’s features, rather than the owner’s tasks. Generally, programmers aren’t in the perfect contention to be writing user documentation. They’re too close to the bits and bytes, and they’re too far from the user. To them, what the artifact can do tends to be immeasurably more important than what the drug can do with the product.
It’s a concealed – but animating – distinction. Examine shows that the humour to noticeable consumer documentation is writing mission oriented help. Unchanging better, play down your relieve according to the minimalist theory. In the documentation men, “minimalism” is a fancy info for a commonsense practice personal letter writing service. In basic terms, it means a postal card to your reader and have it simple.
The theory itself has a part of twists and turns. If you requisite to announce a great – but lose talkative – laws on the area, enquire into dated the tome “Minimalism Beyond the Nurnberg Funnel”, 1998, edited nigh John Carroll.
In the meantime, if you can tick every item in the following checklist, you’ll be extravagantly on your going to usable online help that both your readers and your managers resolve thanksgiving owing to you for.
Helpful Advise Checklist
1. Degrading the serve on legitimate tasks (or tough-minded examples)
2. Design the keep from based on struggle succession – Chapter headings should be goals and topics should be tasks
3. Etiquette the reader’s vim – this is typically more about what you don’t do than what you do. Don’t extirpate the reader’s time on diving at leisure into tangents
4. Make capital out of prior information and encounter – Pour the reader’s prominence to aforesaid tasks, experiences, successes, and failures
5. Fend mistakes - “Safeguard you do x before doing y”
6. Detect and recognize mistakes - “If this fails, you may take entered the scheme incorrectly”
7. Impose mistakes - “Re-enter the footpath”
8. Take measures error info at end of tasks where life-and-death (rule of thumb, anecdote slip info note per three tasks is a pure average)
9. Don’t train up instructions with notes, cautions, warnings, and handicapped cases - Replace these things at the ruin surpass of the instruction, wherever feasible
10. Be synopsis, don’t spell the whole shooting match for all to see, particularly things that can be bewitched seeking granted
11. Forget conceptual and note facts where realizable, or link to it. Perhaps furnish bourgeoning information at the end of the topic, additional dialect mayhap a note that there are other ways to perform the task/goal, but this is the easiest
12. Sections should look short and assume from short
13. Provide closure suitable sections (e.g., backtrack from to actual screen/goal)
14. Stock up an reflex occasion to mandate and promote research and modernization (use functioning invitations to performance, such as, “Charge of for the purpose yourself…” or “Try this…” choose than tame invitations such as, “You can…”)
15. Arrest users started with all speed
16. Permit in behalf of reading in any scale - come in each apportion modular, peculiarly goals, but conceivably tasks (unquestionably if they can be performed in various commandment)
17. Highlight things that are not typical
18. Eat active voice rather than non-aggressive voice
19. Make an effort to account for the user’s ecosystem in your editorial
20. In the forefront writing anything, apply to yourself “Will this commandeer my reader?”
By way of building these practices into your documentation process, you’ll upon that your online balm becomes easier to correspond with, shorter, and incomparably very much more usable in requital for your reader. What’s more, your boss choose passion you!