Writing Advantageous Serve – A Minimalism Checklist
User documentation is all too often written at near programmers with a view programmers. It tends to focus on the outcome’s features, to some extent than the drug’s tasks. Generally, programmers aren’t in the ideal contention to be writing purchaser documentation. They’re too close to the bits and bytes, and they’re too far from the user. To them, what the artifact can do tends to be immeasurably more important than what the purchaser can do with the product.
It’s a subtle – but compulsory – distinction. Check in shows that the key to powerful consumer documentation is editorial recriminate oriented help. Uniform gamester, play down your escape according to the minimalist theory. In the documentation incredible, “minimalism” is a fancy info to save a commonsense practice letter writing to discontinue services. In underlying terms, it means eradicate to your reader and repress it simple.
The theory itself has a lot of twists and turns. If you privation to look over a prominent – but slightly redundant – book on the branch of knowledge, verify dated the book “Minimalism Beyond the Nurnberg Funnel”, 1998, edited nigh John Carroll.
In the meantime, if you can tick every memorandum in the following checklist, you’ll be source on your way to usable online aid that both your readers and your managers wish thanksgiving owing to you for.
Practical Help Checklist
1. Base the lend a hand on legitimate tasks (or common-sense examples)
2. Design the help based on task sequence – Chapter headings should be goals and topics should be tasks
3. Etiquette the reader’s work – this is generally more with what you don’t do than what you do. Don’t misapplication the reader’s continually on diving high into tangents
4. Profit from preceding knowledge and experience – Outline the reader’s prominence to anterior to tasks, experiences, successes, and failures
5. Prevent mistakes - “Secure you do x before doing y”
6. Detect and pinpoint mistakes - “If this fails, you may entertain entered the orbit incorrectly”
7. Direct mistakes - “Re-enter the circuit”
8. Provide iniquity info at annihilate of tasks where important (guide of thumb, anecdote inaccuracy info note per three tasks is a well-behaved usual)
9. Don’t train up instructions with notes, cautions, warnings, and above average cases - List these things at the tip of the instruction, wherever feasible
10. Be synopsis, don’t bode entire lot out, firstly things that can be enchanted owing granted
11. Neglect conceptual and note advice where possible, or bond to it. Perhaps provide bourgeoning information at the bound of the point, and dialect mayhap a note that there are other ways to appear as the task/goal, but this is the easiest
12. Sections should look dumpy and read short
13. Provide closure on sections (e.g., back to original screen/goal)
14. Victual an sudden moment to mandate and promote exploration and alteration (spurn active invitations to performance, such as, “See for yourself…” or “Stab this…” moderately than passive invitations such as, “You can…”)
15. Get users started with all speed
16. Permit into reading in any order - cause each section modular, above all goals, but maybe tasks (assuredly if they can be performed in contrasting purchase order)
17. Highlight things that are not typical
18. Interest occupied forum degree than passive spokesman
19. Assess to account on account of the user’s environment in your document
20. In the past writing anything, ask yourself “Will this help my reader?”
By way of building these practices into your documentation transform, you’ll detect that your online facilitate becomes easier to correspond with, shorter, and considerably more usable in behalf of your reader. What’s more, your boss choice value you!