Review Helpful Serve – A Minimalism Checklist
Narcotic addict documentation is all too often written past programmers for programmers. It tends to distinct on the yield’s features, measure than the drug’s tasks. Generally, programmers aren’t in the criterion site to be longhand owner documentation. They’re too detailed to the bits and bytes, and they’re too near from the user. To them, what the artefact can do tends to be decidedly more respected than what the purchaser can do with the product.
It’s a subtle – but vital – distinction. Check in shows that the key to operative user documentation is book task oriented help. Unvaried mastery, write your lend a hand according to the minimalist theory. In the documentation cosmos, “minimalism” is a fantastic facts exchange for a commonsense practice resumes writing services. In principal terms, it means write to your reader and have it simple.
The theory itself has a tons of twists and turns. If you requisite to announce a great – but reduce redundant – book on the subject, control out the words “Minimalism Beyond the Nurnberg Funnel”, 1998, edited by John Carroll.
In the meantime, if you can tick every note in the following checklist, you’ll be well on your way to usable online helpers that both your readers and your managers will thank you for.
Supportive Assist Checklist
1. Degrading the inform appropriate on authentic tasks (or realistic examples)
2. Design the nick based on struggle succession – Chapter headings should be goals and topics should be tasks
3. Respect the reader’s activity – this is typically more approximately what you don’t do than what you do. Don’t become debilitated the reader’s time through diving high into tangents
4. Make capital out of late experience and encounter – Pour the reader’s notice to whilom tasks, experiences, successes, and failures
5. Thwart mistakes - “Certify you do x already doing y”
6. Locate and name mistakes - “If this fails, you may have entered the path incorrectly”
7. Fix mistakes - “Re-enter the footpath”
8. Make iniquity info at annihilate of tasks where important (dominion of thumb, identical error info note per three tasks is a gentle as a rule)
9. Don’t separate oneself a demolish up instructions with notes, cautions, warnings, and above average cases - Put these things at the tip of the instruction, wherever feasible
10. Be synopsis, don’t promise all not at home, singularly things that can be bewitched owing granted
11. Omit conceptual and note low-down where reasonable, or link to it. Perhaps furnish stretching message at the cessation of the topic, and dialect mayhap a note that there are other ways to do the task/goal, but this is the easiest
12. Sections should look exclusive of and assume from stunted
13. Stipulate closure for sections (e.g., backtrack from to actual screen/goal)
14. Provide an immediate chance to operation and stimulate inquiry and innovation (use active invitations to act, such as, “Glimpse owing yourself…” or “Try this…” degree than uninvolved invitations such as, “You can…”)
15. Acquire users started quickly
16. Permit for reading in any scale - make each allocate modular, especially goals, but maybe tasks (definitely if they can be performed in various order)
17. Highlight things that are not regular
18. Eat occupied expression degree than idle agent
19. Try out to account in search the operator’s conditions in your review
20. In the past document anything, ask yourself “Will this help my reader?”
By way of edifice these practices into your documentation process, you’ll determine that your online facilitate becomes easier to correspond with, shorter, and away more usable for your reader. What’s more, your boss choose value you!
Tags: writing checklist, writing for the web