User documentation is all too often written by programmers for programmers. It tends to focus on the product's features, rather than the user's tasks. Generally, programmers aren't in the ideal position to be writing user documentation. They're too close to the bits and bytes, and they're too far from the user. To them, what the product can do tends to be far more important than what the user can do with the product.
It's a subtle ? but vital ? distinction. Research shows that the key to effective user documentation is writing task oriented help. Even better, write your help according to the minimalist theory. In the documentation world, "minimalism" is a fancy word for a commonsense practice. In basic terms, it means write to your reader and keep it simple.
The theory itself has a lot of twists and turns. If you want to read a great ? but slightly wordy ? book on the subject, check out the book "Minimalism Beyond the Nurnberg Funnel", 1998, edited by John Carroll.
In the meantime, if you can tick every item in the following checklist, you'll be well on your way to usable online help that both your readers and your managers will thank you for.
Helpful Help Checklist
1. Base the help on real tasks (or realistic examples)
2. Structure the help based on task sequence ? Chapter headings should be goals and topics should be tasks
3. Respect the reader's activity ? this is generally more about what you don't do than what you do. Don't waste the reader's time by diving off into tangents
4. Exploit prior knowledge and experience ? Draw the reader's attention to previous tasks, experiences, successes, and failures
5. Prevent mistakes - "Ensure you do x before doing y"
6. Detect and identify mistakes - "If this fails, you may have entered the path incorrectly"
7. Fix mistakes - "Re-enter the path"
8. Provide error info at end of tasks where necessary (rule of thumb, one error info note per three tasks is a good average)
9. Don't break up instructions with notes, cautions, warnings, and exceptional cases - Put these things at the end of the instruction, wherever possible
10. Be brief, don't spell everything out, especially things that can be taken for granted
11. Omit conceptual and note information where possible, or link to it. Perhaps provide expansion information at the end of the topic, plus maybe a note that there are other ways to perform the task/goal, but this is the easiest
12. Sections should look short and read short
13. Provide closure for sections (e.g., back to original screen/goal)
14. Provide an immediate opportunity to act and encourage exploration and innovation (use active invitations to act, such as, "See for yourself..." or "Try this..." rather than passive invitations such as, "You can...")
15. Get users started quickly
16. Allow for reading in any order - make each section modular, especially goals, but perhaps tasks (definitely if they can be performed in different order)
17. Highlight things that are not typical
18. Use active voice rather than passive voice
19. Try to account for the user's environment in your writing
20. Before writing anything, ask yourself "Will this help my reader?"
By building these practices into your documentation process, you'll find that your online help becomes easier to write, shorter, and far more usable for your reader. What's more, your boss will love you!
About The Author
* Glenn Murray is an seo copywriter and seo copywriter. He is a director of seo copywriter and also of copywriting studio Divine Write. He can be contacted on Sydney +612 4334 6222 or at seo copywriter. Visit http://www.divinewrite.com or http://www.publishhub.com for further details, more FREE articles, or to purchase his e-book, 'SEO Secrets'.
cheap limo service Lombard .. Lockport Chicago limo O’HareAs a freelance writer, it is important to present yourself... Read More
Have you ever wondered why some people can make millions... Read More
In this article you will find tips on: How to... Read More
Writing papers and book reports has long been the bane... Read More
IntroductionSometimes it may be beyond a companies or individuals budget... Read More
1. What Is A Premise?A premise is the point you... Read More
Real Estate has "Location, location, location," and writing has "Clips,... Read More
Punctuation, when used creatively, is powerful. Note, however, that when... Read More
Golden Rules For New Writers - Things you need to... Read More
An island in the Mediterranean. A beach in Africa. The... Read More
Although he has his own website, John Grisham probably does... Read More
Short Story Writing Tips -We've established what a title should... Read More
My bookcase take up one whole wall in the family... Read More
There are three ways to write a first draft. One... Read More
Chances are, you'll be busy over the next several weeks.... Read More
Next time you're tempted to use italics for emphasis... STOP!"Why?"... Read More
Traditionally, business writing uses the "one thing after another" format,... Read More
Having trouble finding a solution to a nagging problem? Try... Read More
Most people can easily identify with the dreaded "writer's block".... Read More
Right off the bat, I want to say that there... Read More
I've noticed a big shift away from traditional horror recently,... Read More
You may not remember this, but in the early days... Read More
Human beings seem to be born with a gene for... Read More
What a lack of research could do to you.When creating... Read More
Want to write an article or book, but are stuck... Read More
limo O'Hare Glen Ellyn ..Simply put, it is the art of writing scripts for... Read More
Having problems writing? I don't know why. San Francisco Chronicle... Read More
Paulo Coelho was born on August 24th 1947 in Rio... Read More
All writers should use a plan whether written or reflected.... Read More
Do you consider yourself a storyteller? Do you consider yourself... Read More
The only way to become a writer is to write.... Read More
Someone once commented that there were no new ideas to... Read More
As an aspiring or an established entrepreneur, you are an... Read More
Kallu was a tenant of Santosh Kumar Nayak. Santosh Kumar... Read More
Have you ever written a letter to a friend? Ever... Read More
My dad was wrong. I just discovered that I am... Read More
Mix a martini, don't forget the olives, or pour yourself... Read More
If a writer considers writing to be a task, he/she... Read More
If you dread the thought of writing, if you fear... Read More
During my 25-year career in a variety of professional positions... Read More
Want to write your book? But, need a blueprint on... Read More
Whenever you sit down to plot a story (or even... Read More
1. PLAY A GAME LIKE SOLITAIRE....for half an hour or... Read More
~~~Old age, to the unlearned, is winter; to the learned,... Read More
You have just completed a draft of an article. It... Read More
Is your book nearly finished, finished, published, or even in... Read More
So you want to be a successful author? You want... Read More
11 Secrets from an Experienced InterviewerOne of the unwritten rules... Read More
Yes, you know your subject. You also need to think... Read More
To write books for readers at an elementary reading level... Read More
Writing |