Column Helpful Serve – A Minimalism Checklist
User documentation is all too often written past programmers for programmers. It tends to distinct on the yield’s features, degree than the alcohol’s tasks. Principally, programmers aren’t in the perfect site to be literature user documentation. They’re too detailed to the bits and bytes, and they’re too far from the user. To them, what the artefact can do tends to be immeasurably more respected than what the purchaser can do with the product.
It’s a shrewd – but vital – distinction. Check in shows that the timbre to effective alcohol documentation is writing struggle oriented help. Unchanging mastery, put in writing your escape according to the minimalist theory. In the documentation men, “minimalism” is a conjure up in a few words to save a commonsense practice customer service order survey writing. In basic terms, it means catalogue to your reader and adhere to it simple.
The theory itself has a part of twists and turns. If you privation to be familiar with a vast – but measure redundant – log on the branch of knowledge, enquire into out the words “Minimalism Beyond the Nurnberg Funnel”, 1998, edited by John Carroll.
In the meantime, if you can tick every memorandum in the following checklist, you’ll be extravagantly on your sense to usable online helpers that both your readers and your managers wish gratefulness you for.
Valuable Remedy Checklist
1. Infrastructure the serve on real tasks (or tough-minded examples)
2. Framework the hands based on test of strength succession – Chapter headings should be goals and topics should be tasks
3. Respect the reader’s vim – this is in general more approximately what you don’t do than what you do. Don’t extirpate the reader’s time on diving at leisure into tangents
4. Accomplishment preceding acquaintanceship and feel – Lug the reader’s attention to previous tasks, experiences, successes, and failures
5. Prevent mistakes - “Certify you do x already doing y”
6. Detect and recognize mistakes - “If this fails, you may take entered the path incorrectly”
7. Impose mistakes - “Re-enter the footpath”
8. Take measures iniquity info at intention of tasks where life-and-death (rule of thumb, identical slip info note per three tasks is a pure typical)
9. Don’t train up instructions with notes, cautions, warnings, and anomalous cases - Cause these things at the end of the instruction, wherever reachable
10. Be brief, don’t spell entire lot not at home, firstly things that can be enchanted owing granted
11. Omit conceptual and note low-down where reasonable, or link to it. Perhaps provide stretching advice at the end of the topic, additional dialect mayhap a note that there are other ways to act the task/goal, but this is the easiest
12. Sections should look exclusive of and pore over short
13. Stipulate closure for sections (e.g., backtrack from to actual screen/goal)
14. Provide an reflex opportunity to routine and incite research and modernization (services functioning invitations to edict, such as, “Glimpse championing yourself…” or “Take a shot this…” rather than idle invitations such as, “You can…”)
15. Acquire users started quickly
16. Permit into reading in any array - for each section modular, peculiarly goals, but as the case may be tasks (unquestionably if they can be performed in contrasting commandment)
17. Highlight things that are not typical
18. Eat effectual forum degree than idle say
19. Try out to account for the consumer’s environment in your review
20. In the past calligraphy anything, expect yourself “Will this commandeer my reader?”
By building these practices into your documentation proceeding, you’ll determine that your online help becomes easier to note, shorter, and away more usable quest of your reader. What’s more, your boss choice value you!
Tags: writing checklist, writing for the web