Writing Helpful Help ? A Minimalism Checklist

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'.

In The News:


pen paper and inkwell


cat break through


Who Else Wants To Make $3546 By Simply Pressing a Button!

If you have been online for any length of time... Read More

Unusual Points of View

Most writers are familiar with first and third points of... Read More

Another Way to Show Your Expertise: Write a Book!

Maybe you should write a book! This is not as... Read More

10 Tips on How to Cultivate Relationships with Editors

If you are an aspiring writer, or you simply want... Read More

Persisting With Bulldog Determination

Persisting With Bulldog Determination [Book excerpt from Successercising} by Rick... Read More

Talent or Toil

As in all endeavors, toil is necessary to succeed and... Read More

Bring Out the Natural Writer in You

Think you can't write a book that will sell? You... Read More

A Plan

All writers should use a plan whether written or reflected.... Read More

Celebrating Writing and Life

Every morning I excitedly get out of bed. Just a... Read More

Overcoming Writers Block

Do you suffer from writer's block? Is there a pending... Read More

Writing Tips for your Journey

Tips for your writing journeySo, you'd like to be a... Read More

A Writers Inner Battle

There is a psychological nuisance so powerful that can deflate... Read More

Writers can Grow to be Comfortable with Criticism

On my first newspaper assignment as a critic, I was... Read More

Five Golden Rules for Writers

Regardless of what sort of writer you are and how... Read More

Be Your Own Literary Agent and Get Published

So you're one of 20 million Americans who want to... Read More

Writing Made Them Rich #3: Richard Bach

One day in the mid-1970's a young man stumbled into... Read More

Formats for Writing Life Narratives

Q and A.Best choice when subject is very verbal or... Read More

Write Possibilities

We writers are a powerful lot. We control time. We... Read More

Sharpen Your Writing With Structure

At some point, every serious writer is forced to sit... Read More

A Book Note Vs a Book Report

IntroductionSince our early days of elementary education we have been... Read More

Getting To Know Your Characters

Interesting characters that readers care about are the most important... Read More

Characters In A Romance Novel

Before you even begin writing your novel, you need to... Read More

Publication Road

The journey to having my first novel for children published... Read More

8 Tips to Get Publishers to Notice You

If your articles aren't getting published very often, or you... Read More

Know Your Editing Choices

Each author has special editing needs. To save yourself time... Read More

You Cant Always Believe What You See On Your Computer Screen

You may not remember this, but in the early days... Read More

Ten Quick Tips for Inexperienced Writers

One of the biggest problems that inexperienced writers have is... Read More

A Quick Guide to ISBNs for Self-Publishers

ISBN stands for International Standard Book Number. It is a... Read More

Alternative View Points and the Lamp of Creativity

Pictures they say are worth a thousand words, but many... Read More

Hero?s Journey ? The First Threshold

Beyond three and four act story structure, lies the Hero's... Read More

Weaving Your Personal Statement Together

1. SECRETS TO SUCCESS2. MAKING A POWERFUL FIRST IMPRESSION3. AVOID... Read More

The Iniquitous Slip

All the famous writers I heard of could paper the... Read More

Learning How To Write

As a student of Spanish, my goal was to think... Read More