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 [email protected]. 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:


How to Build Your Site with Other Peoples Content -- Part 1

Building a new website can be extremely exciting. Seeing your... Read More

Top Seven Ways to Write your Print or eBook Fast

Want to write your book? But, need a blueprint on... Read More

The Prologue - When to Use One, How to Write One

What is a prologue? When should you use one? Should... Read More

Get Published: The Nuts and Bolts of Good English, and How to Impress a Publisher (1)

Not all writers write good grammar. That's a fact. It's... Read More

Creative Writing Tips - Does The Name You Chose Suit Your Character?

How do you choose a name? Do you put down... Read More

The Myths Of Writing: Have You Bought Into These?

There is an image most people carry of the artist... Read More

Is Your Title Compelling?

Short Story Writing Tips:Your title is your selling tool. It's... Read More

8 Tell-Tale Signs That Forecast Writing Success!

'Talent is cheaper than table salt. What separates the talented... Read More

Is Now the Time for a Play about the War in Iraq?

Everone knows that comedy is mostly about timing. If you... Read More

Linguaphone Language Learning Solutions

Language Training - A key to Global CommunicationLanguage Training is... Read More

Writing Press Releases That Get Noticed

Among the various foolproof methods used to boost traffic to... Read More

Baby Boomers and Booklets ? Share and Share Alike

As one of those fabulous Baby Boomers, you now own... Read More

Seven Important Lessons for Experts Who Want to Get Published

At first, I noticed that I could have written many... Read More

7 Essential Letter Writing Strategies

Based on the feedback that I have been getting from... Read More

Writing Is Not Life-threatening

Some writers complain that writing is arduous work requiring long... Read More

7 Book Publicity Tips for Authors and Small Publishers

The biggest mistake authors make when trying to get free... Read More

Get Published: The Nuts and Bolts of English, and How to Impress a Publisher (2)

The tiniest things can be so useful when you come... Read More

How To Write More Powerful Reports

There is one key difference between reports and most other... Read More

Five Common Errors to Correct Before Submitting a Letter or Report

First impressions count in writing too! So it is always... Read More

Open a Vein

If you want to be a writer, you must write... Read More

Making The Time To Write That Novel

Finding the time to write a novel is one of... Read More

Uncommon Advice for Beginning Novelists

1) Convince yourself you want to do something else. If... Read More

Need a Book Coach, Ghost Writer, or Editor? Part 1

If you either want to write a book to help... Read More

Learning to Question Your Elephant Child: Who, What, Where, When and Why

Having problems writing? I don't know why. San Francisco Chronicle... Read More

Starting a Freelance Writing Career (or Thoughts About Taking the Plunge)

Nike's ad has taken on new meaning for me of... Read More