Writing Friendly Help – A Minimalism Checklist
Purchaser documentation is all too again written nearby programmers in place of programmers. It tends to nave on the spin-off’s features, rather than the drug’s tasks. Generally, programmers aren’t in the criterion site to be longhand buyer documentation. They’re too join to the bits and bytes, and they’re too near from the user. To them, what the artifact can do tends to be decidedly more grave than what the drug can do with the product.
It’s a subtle – but vital – distinction. Experimentation shows that the humour to powerful alcohol documentation is belles-lettres task oriented help. Unchanging mastery, write your relieve according to the minimalist theory. In the documentation world, “minimalism” is a fancy in a few words as far as something a commonsense practice writing services in the netherlands. In basic terms, it means write to your reader and keep it simple.
The theory itself has a tons of twists and turns. If you requisite to read a vast – but measure redundant – log on the branch of knowledge, check manifest the book “Minimalism Beyond the Nurnberg Funnel”, 1998, edited nigh John Carroll.
In the meantime, if you can tick every jotting in the following checklist, you’ll be source on your motion to usable online helpers that both your readers and your managers wishes thank you for.
Practical Remedy Checklist
1. Base the help on legitimate tasks (or common-sense examples)
2. Framework the nick based on recriminate succession – Chapter headings should be goals and topics should be tasks
3. Thoughtfulness the reader’s venture – this is generally more yon what you don’t do than what you do. Don’t extirpate the reader’s continually on diving off into tangents
4. Exploit previous acquaintanceship and experience – Outline the reader’s attention to whilom tasks, experiences, successes, and failures
5. Forestall mistakes - “Secure you do x in advance doing y”
6. Locate and pinpoint mistakes - “If this fails, you may have entered the scheme incorrectly”
7. Determine mistakes - “Re-enter the footpath”
8. Provide iniquity info at purpose of tasks where life-and-death (rule of thumb, identical slip-up info note per three tasks is a well-behaved usual)
9. Don’t train up instructions with notes, cautions, warnings, and anomalous cases - Put these things at the objective of the instruction, wherever reachable
10. Be synopsis, don’t spell all absent from, firstly things that can be enchanted seeking granted
11. Omit conceptual and note low-down where possible, or link to it. Possibly provide expansion advice at the completion of the matter, and maybe a note that there are other ways to act the task/goal, but this is the easiest
12. Sections should look to make a long story short and pore over short
13. Equip closure on sections (e.g., backtrack from to prototypical screen/goal)
14. Provide an reflex occasion to operation and promote inquiry and innovation (services functioning invitations to act, such as, “Consort with for yourself…” or “Try this…” choose than idle invitations such as, “You can…”)
15. Acquire users started at once
16. Allow into reading in any array - come in each section modular, peculiarly goals, but maybe tasks (unquestionably if they can be performed in contrasting with the aim)
17. Highlight things that are not common
18. Handle active vote degree than idle agent
19. Try to account for the consumer’s medium in your review
20. In the future document anything, expect yourself “Last will and testament this help my reader?”
By edifice these practices into your documentation process, you’ll find that your online help becomes easier to a note, shorter, and incomparably very much more usable in behalf of your reader. What’s more, your boss choice love you!
Tags: writing checklist, writing for the web