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 Article Submission Specialist. He is a director of PublishHub and also of copywriting studio Divine Write. He can be contacted on Sydney +612 4334 6222 or at glenn@divinewrite.com. Visit http://www.divinewrite.com or http://www.publishhub.com for further details, more FREE articles, or to purchase his e-book, 'SEO Secrets'.
If you have been online for any length of time... Read More
Most writers are familiar with first and third points of... Read More
Maybe you should write a book! This is not as... Read More
If you are an aspiring writer, or you simply want... Read More
Persisting With Bulldog Determination [Book excerpt from Successercising} by Rick... Read More
As in all endeavors, toil is necessary to succeed and... Read More
Think you can't write a book that will sell? You... Read More
All writers should use a plan whether written or reflected.... Read More
Every morning I excitedly get out of bed. Just a... Read More
Do you suffer from writer's block? Is there a pending... Read More
Tips for your writing journeySo, you'd like to be a... Read More
There is a psychological nuisance so powerful that can deflate... Read More
On my first newspaper assignment as a critic, I was... Read More
Regardless of what sort of writer you are and how... Read More
So you're one of 20 million Americans who want to... Read More
One day in the mid-1970's a young man stumbled into... Read More
Q and A.Best choice when subject is very verbal or... Read More
We writers are a powerful lot. We control time. We... Read More
At some point, every serious writer is forced to sit... Read More
IntroductionSince our early days of elementary education we have been... Read More
Interesting characters that readers care about are the most important... Read More
Before you even begin writing your novel, you need to... Read More
The journey to having my first novel for children published... Read More
If your articles aren't getting published very often, or you... Read More
Each author has special editing needs. To save yourself time... Read More
You may not remember this, but in the early days... Read More
One of the biggest problems that inexperienced writers have is... Read More
ISBN stands for International Standard Book Number. It is a... Read More
Pictures they say are worth a thousand words, but many... Read More
Beyond three and four act story structure, lies the Hero's... Read More
1. SECRETS TO SUCCESS2. MAKING A POWERFUL FIRST IMPRESSION3. AVOID... Read More
All the famous writers I heard of could paper the... Read More
As a student of Spanish, my goal was to think... Read More
Since the headline is the first contact your readers have... Read More
Creative Writing Tips ?The writer, who doesn't have the time... Read More
The Big IdeaOkay. So youve figured out that you would... Read More
If you are looking for copywriter books, you'll want to... Read More
If you are reading this article then you probably have... Read More
A writer can never be self indulgent whether writing fiction,... Read More
It turns out that "tips and templates on how to... Read More
EditingExpect, allow, and accept that every first draft will represent... Read More
Whether you keep a separate spiritual journal or just want... Read More
My Dad has this old joke that goes, "What's the... Read More
Do you love someone very deeply? A spouse, son, daughter,... Read More
1. SECRETS TO SUCCESS2. MAKING A POWERFUL FIRST IMPRESSION3. AVOID... Read More
Word processors are so widely used now that I tend... Read More
Okay. So I'm not David Letterman. But I doubt if... Read More
Having trouble finding a solution to a nagging problem? Try... Read More
Your computer is a writing machine, a word processor, a... Read More
When I first started tracking the information preferences of people... Read More
I have added a new word to my vocabulary. Logorrhea.... Read More
(Skip directly to ten for the fastest shortcut!)Like any field,... Read More
Think of writing like karate...it's about DISCIPLINE.Writing, like other forms... Read More
Back in the mid to late 1980s I was a... Read More
Building a new website can be extremely exciting. Seeing your... Read More
When a writer is working on their next literary masterpiece... Read More
The writing community is a strong one, with many new... Read More
1. Remember publication is a business; writing is an art.... Read More
1) Convince yourself you want to do something else. If... Read More
A certified proofreader is one that has taken a few... Read More
One day in the mid-1970's a young man stumbled into... Read More
In the words of Aristotle, "happiness is self contentedness helping... Read More
Eight or nine times out of ten, picking up and... Read More
In large publishing houses, many manuscripts penned by first-time authors,... Read More
It's cliché, but true-a picture does paint a thousand words.... Read More
So, you want to freelance as an editor, writer, copy... Read More
Writing |