|
Author: Glenn Murray Article source: http://www.msjsoftware.com/. Used with author's permission.
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! * Glenn Murray is an SEO copywriter and article submission and article PR specialist. He is a director of article PR company, Article PR, and also of copywriting studio Divine Write. He can be contacted on Sydney +612 4334 6222 or at glenn@divinewrite.com. Visit www.DivineWrite.com or www.ArticlePR.com for further details, more FREE articles, or to download his FREE SEO e-book.
How I Learned Simple And Popular Face Painting Techniques
Tips and Tricks about face painting, the best ways to learn the art of face painting for birthday parties, school and fundraising events. Simple yet popular des...
Top Interview Questions for Jobs in Big Companies
In this era of tough competitions a youngman has to prepare well to succeed in an interview. Here are possible answers of some top interview questions generall...
Discipline Medicine
Since writing requires discipline, here are way to achieve that.
Sharing the Reins: 10 Reasons To Sell Your Company To Your Employees
In 1987 I sold my business, South Mountain Company, to my employees (and myself). My sole proprietorship became an employee-owned cooperative corporation. It wa...
Some Healthy Ways to Fight Acne
This article provides some tips on controlling Acne in natural ways.
THE Step to Working Smarter (Japanese Style)
Remember that Coke contest from the 80s? If you collected bottle tops that had the letters to spell T-H-E R-E-A-L T-H-I-N-G, then youd win a zillion dollars. I...
Toddler Tantrums
Remember the adorable little cherub you brought home from the hospital?
Ah, It seems like only yesterday. Now your baby has grown into a toddler. The world to t...
Ezine Promotion, The Three Forgotten Tactics
If you are like most ezine publishers you want more ideas that work. But hold on a minute what about all the key strategies that you have overlooked?
Five Ways to Increase Your Website Conversion Rate
Though it's wonderful to get all those hits to your e-commerce web site, hits don't mean much unless you convert them into sales. This is especially true if yo...
Five Secrets to Playing in the New Age Style
Describes an intuitive approach to piano playing.
Utilizing Your Best Hidden Asset To Increase Sales
You probably already have in your possession one of the most valuable
and powerful assets you can possibly own. But if you're like most
business people you pr...
The Builder from Hell
A first home buyer battles the real world.
3 Ingredients of Highly Profitable Organizational Change
As waves of organizational change sweep across the business landscape, a huge question arises: What must a leader do to make sure change produces highly profit...
Do Traditional Hair Loss Remedies Have Any Relevance Today?
This article looks at some of the traditional hair loss remedies that may have been forgotten.
Being a Good Coach
Andre Agassi, Brett Favre, Christine Aguilera, what do they all have in common-a good coach. Being a good manager or leader is essential to developing your sta...
Mortgage Prepayment Penalties - Just Say No
One of the most common terms found in a new home loan is a prepayment penalty. This type of penalty says that if the borrower pays off the loan early, commonly ...
Hedge Funds
You read and hear a lot about hedge funds. Unfortunately, most of what you hear is negative because it comes from the major media that has an interest in report...
Take The Time
You must take the time once a month to review your investment portfolio. It won't take long - less than one hour, maybe 15 minutes...
Building a Web Store on Shoestring Budget in less than Four Hours
Starting a business online is no longer as difficult as it used
to be! Now, there are plenty of interesting business ideas that
anybody can pick up from vario...
Basic Furniture and Its Place In Design
When it comes to furniture, you have several different types. There is basic, custom handcrafted, and thrift shop types to name a few.
Looking for Work in All the Wrong Places
The Question: After identifying a potential employer, I get contact information, do my research and send out my resume and cover letter, requesting an interview...
Patience
How can you teach children patience?
10 Tips for Writing Web Copy
One of the most important aspects of a website today is the webcopy - sometimes called the sales letter. In days gone bye, banners and graphics were all importa...
Wild Watercress Soupt (Nasturtium officinale)
Wild Watercress soup is a delicious and nutritious recipe with the leaves available in spring and early summer. Watercress is rich in Vitamins A and C, iron, io...
|
Print this page