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

---

Writing Without Style

Style manuals are all well and good, and in fact,... Read More

Write Possibilities

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

A Writers Tools

If you are like most writers, you're constantly searching for... Read More

Does Your Theme Contain Character, Conflict, Resolution?

Creative Writing Tips ?For a theme to work and the... Read More

How to Have an Effective Writing Group

The works you've written are numerous, ranging from short stories... Read More

7 Reference Books for Your Desk

I hate to admit this, but I rarely get an... Read More

Scenes and Structure

Beginning writers often tend to think of a book as... Read More

8 Quick Tips on Creating Vivid, Memorable Characters

These 8 tips on using characters in your stories will... Read More

Create Confidence With Your Writing

Whether you are writing a magazine article, composing a press... Read More

The Hard Facts About Editing

Whether you're interviewing for a new job, trying to woo... Read More

Realize Your Book Dream In 2005!

If you haven't realized the success you wanted last year,... Read More

Freelance Feast or Famine?

Sometimes a freelance writing career can feel very much like... Read More

Cheap Therapy

I call it cheap therapy. That gushing, near-religious, poured-from-the-body stress... Read More

Childrens Stories - The Essentials

There is no specific formula for children's fiction. There are,... Read More

7 Steps to Successful Publishing

The decision to publish a book is very exciting! It... Read More

Revving Up Your Writing Productivity

Productivity begins by recognizing and valuing your brilliance, time, and... Read More

How to Create Stories that Sizzle

How to Start Your Story with a BangThe purpose of... Read More

Top Seven Mistakes Writers Make and What to Do About Them

Writers often get stuck because they make assumptions about writing,... Read More

Freelancing Doesnt Mean Writing For Free. Does it?

Writer's forums are bustling with debate over whether or not... Read More

A Series of Articles on Autobiography

ESSAYS ON AUTOBIOGRAPHY: NUMBER 1Preamble:Nearly seven years ago I wrote... Read More

Write That Down! Compulsively Collecting Content for Your Writing

Have you ever read someone else's writing and thought one... Read More

How Can You Find Freelance Work As A Writer?

For those looking at the jobs listings for writers, they... Read More

Top Ten Ways to Write a Book That Sells

Is there a book inside of you? Yes? Then why... Read More

Pages: Your Book of Life

Many of us dream of writing a book. Why not.... 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

Create A Dream Diary

How many times have you forced yourself to sit in... Read More

Writing Made Them Rich #1: JK Rowling

Joanne Kathleen Rowling was born in Chipping Sodbury,England in 1965.... Read More

Can Your Theme Be Proved In Your Story?

Creative Writing Tips ?Your theme has to be something you... Read More

How To Write A Newsletter

In order to be successful with a newsletter, specialize in... Read More

From Book Notes to Book Reports

Writing papers and book reports has long been the bane... Read More

An Introduction to Self Publishing Material

Any article, report or book which is bought or sold... Read More

Seven Important Lessons for Experts Who Want to Get Published

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

Idea-Mining for Writers, 102

As many authors are fond of stating, "Ideas are all... Read More