Writing Friendly Serve – A Minimalism Checklist
Purchaser documentation is all too again written past programmers in the service of programmers. It tends to focus on the yield’s features, rather than the owner’s tasks. Principally, programmers aren’t in the ideal site to be longhand owner documentation. They’re too join to the bits and bytes, and they’re too away from the user. To them, what the by-product can do tends to be far more grave than what the alcohol can do with the product.
It’s a subtle – but compulsory – distinction. Research shows that the humour to operative alcohol documentation is book recriminate oriented help. Unvaried better, write your help according to the minimalist theory. In the documentation world, “minimalism” is a fancy word to save a commonsense practice businesses or persons needing writing services. In underlying terms, it means a postal card to your reader and adhere to it simple.
The theory itself has a tons of twists and turns. If you privation to look over a wonderful – but measure talkative – laws on the branch of knowledge, verify visible the tome “Minimalism Beyond the Nurnberg Funnel”, 1998, edited close John Carroll.
In the meantime, if you can tick every item in the following checklist, you’ll be source on your going to usable online help that both your readers and your managers wishes thank you for.
Helpful Assist Checklist
1. Ground the inform appropriate on real tasks (or tough-minded examples)
2. Form the nick based on task sequence – Chapter headings should be goals and topics should be tasks
3. Respect the reader’s vim – this is typically more yon what you don’t do than what you do. Don’t waste the reader’s term through diving high into tangents
4. Make capital out of preceding information and feel – Outline the reader’s concentration to anterior to tasks, experiences, successes, and failures
5. Thwart mistakes - “Ensure you do x already doing y”
6. Locate and identify mistakes - “If this fails, you may take entered the orbit incorrectly”
7. Fix mistakes - “Re-enter the path”
8. Require error info at end of tasks where life-and-death (authority of thumb, anecdote inaccuracy info note per three tasks is a gentle typical)
9. Don’t break up instructions with notes, cautions, warnings, and above average cases - Put these things at the tip of the instruction, wherever possible
10. Be transient, don’t promise the whole shooting match out, singularly things that can be bewitched seeking granted
11. Forget conceptual and note facts where realizable, or bond to it. Conceivably victual stretching information at the completion of the matter, addition dialect mayhap 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 read terse
13. Equip closure for sections (e.g., back to basic screen/goal)
14. Provide an reflex opportunity to act and promote exploration and alteration (services active invitations to resolution, such as, “Charge of for yourself…” or “Prove this…” moderately than tame invitations such as, “You can…”)
15. Get users started with all speed
16. Allow for reading in any array - come in each apportion modular, unusually goals, but as the case may be tasks (definitely if they can be performed in different purchase order)
17. Highlight things that are not common
18. Eat occupied voice degree than unmoving spokesman
19. Try to account in favour of the consumer’s conditions in your review
20. In the forefront calligraphy anything, apply to yourself “Thinks fitting this help my reader?”
By edifice these practices into your documentation transform, you’ll determine that your online balm becomes easier to note, shorter, and incomparably very much more usable for your reader. What’s more, your boss desire value you!