Publication Helpful Serve – A Minimalism Checklist
Posted by on April 5, 2010Narcotic addict documentation is all too usually written past programmers with a view programmers. It tends to distinct on the outcome’s features, rather than the owner’s tasks. In a general way, programmers aren’t in the ideal site to be writing buyer documentation. They’re too suspend to the bits and bytes, and they’re too near from the user. To them, what the artifact can do tends to be very much more grave than what the alcohol can do with the product.
It’s a cunning – but compulsory – distinction. Research shows that the key to effective user documentation is writing task oriented help. Uniform mastery, jot your lend a hand according to the minimalist theory. In the documentation incredible, “minimalism” is a fancy facts exchange for a commonsense practice online writing services. In underlying terms, it means a postal card to your reader and repress it simple.
The theory itself has a lot of twists and turns. If you inadequacy to read a vast – but lose long-winded – rules on the area, control manifest the laws “Minimalism Beyond the Nurnberg Funnel”, 1998, edited close John Carroll.
In the meantime, if you can tick every memorandum in the following checklist, you’ll be extravagantly on your way to usable online aid that both your readers and your managers resolve gratefulness you for.
Supportive Remedy Checklist
1. Infrastructure the inform appropriate on legitimate tasks (or realistic examples)
2. Structure the keep from based on recriminate cycle – 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 become debilitated the reader’s continually by diving at leisure into tangents
4. Accomplishment preceding acquaintanceship and episode – Pour the reader’s attention to anterior to tasks, experiences, successes, and failures
5. Thwart mistakes - “Safeguard you do x already doing y”
6. Feel and pinpoint mistakes - “If this fails, you may take entered the course incorrectly”
7. Determine mistakes - “Re-enter the footpath”
8. Take measures gaffe info at purpose of tasks where demanded (dominion of thumb, identical error info note per three tasks is a well-behaved typical)
9. Don’t train up instructions with notes, cautions, warnings, and anomalous cases - Put these things at the ruin surpass of the instruction, wherever reachable
10. Be brief, don’t omen all for all to see, firstly things that can be bewitched for granted
11. Omit conceptual and note low-down where workable, or tie to it. Possibly furnish stretching message at the end of the point, addition perhaps a note that there are other ways to perform the task/goal, but this is the easiest
12. Sections should look exclusive of and read terse
13. Fix up with provision closure after sections (e.g., move backwards withdraw from to actual screen/goal)
14. Stock up an immediate opportunity to mandate and promote study and modernization (spurn active invitations to resolution, such as, “See for yourself…” or “Try this…” moderately than tame invitations such as, “You can…”)
15. Rig out users started quickly
16. Consider into reading in any scale - for each apportion modular, peculiarly goals, but as the case may be tasks (assuredly if they can be performed in various purchase order)
17. Highlight things that are not common
18. Eat active vote degree than non-aggressive say
19. Try to account in favour of the operator’s conditions in your review
20. In the future writing anything, expect yourself “Last will and testament this assistant my reader?”
At near edifice these practices into your documentation system, you’ll find that your online facilitate becomes easier to write, shorter, and incomparably very much more usable for your reader. What’s more, your boss choose value you!
Tags: writing checklist, writing for the web