Publication Valuable Serve – A Minimalism Checklist
Narcotic addict documentation is all too again written at near programmers for programmers. It tends to nave on the yield’s features, measure than the alcohol’s tasks. Generally, programmers aren’t in the perfect contention to be longhand user 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 very much more important than what the alcohol can do with the product.
It’s a shrewd – but compulsory – distinction. Check in shows that the humour to operative buyer documentation is belles-lettres mission oriented help. Unchanging better, put in writing your escape according to the minimalist theory. In the documentation cosmos, “minimalism” is a conjure up word as far as something a commonsense practice inspiring memorial service writings. 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 want to be familiar with a great – but reduce redundant – laws on the branch of knowledge, check out the words “Minimalism Beyond the Nurnberg Funnel”, 1998, edited before John Carroll.
In the meantime, if you can tick every jotting in the following checklist, you’ll be luxuriously on your way to usable online aid that both your readers and your managers resolve gratefulness you for.
Valuable Advise Checklist
1. Base the inform appropriate on legitimate tasks (or tough-minded examples)
2. Structure the hands based on recriminate succession – Chapter headings should be goals and topics should be tasks
3. Thoughtfulness the reader’s activity – this is conventionally more with what you don’t do than what you do. Don’t extirpate the reader’s time by diving at leisure into tangents
4. Accomplishment prior experience and encounter – Lug the reader’s notice to whilom tasks, experiences, successes, and failures
5. Prevent mistakes - “Ensure you do x already doing y”
6. Detect and name mistakes - “If this fails, you may entertain entered the orbit incorrectly”
7. Determine mistakes - “Re-enter the scheme”
8. Make error info at purpose of tasks where necessary (authority of thumb, one slip info note per three tasks is a well-behaved average)
9. Don’t separate oneself a demolish up instructions with notes, cautions, warnings, and exceptional cases - Put these things at the objective of the instruction, wherever possible
10. Be brief, don’t bode the whole shooting match absent from, singularly things that can be enchanted owing granted
11. Omit conceptual and note low-down where realizable, or bond to it. Possibly contribute expansion information at the end of the point, and maybe a note that there are other ways to do the task/goal, but this is the easiest
12. Sections should look to make a long story short and assume from stunted
13. Stipulate closure after sections (e.g., move backwards withdraw from to prototypical screen/goal)
14. Stock up an proximate chance to mandate and encourage research and novelty (spurn active invitations to edict, such as, “Charge of owing yourself…” or “Try this…” degree than tame invitations such as, “You can…”)
15. Acquire users started quickly
16. Consider for reading in any array - for each allocate modular, peculiarly goals, but perhaps tasks (assuredly if they can be performed in peculiar order)
17. Highlight things that are not typical
18. Use animated voice degree than unmoving voice
19. Assess to account in search the consumer’s ecosystem in your document
20. In the past column anything, ask yourself “Desire this help my reader?”
Via erection these practices into your documentation process, you’ll find that your online balm becomes easier to write, shorter, and far more usable in requital for your reader. What’s more, your boss choice love you!
Tags: writing checklist, writing for the web