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 write a killer abstract in 10 sentences  American Society for Biochemistry and Molecular Biology
Opinion | Why I Write  The New York Times

Focusing Your Reading and Finding Ideas

Many experts recommend reading as a way to get ideas,... Read More

From Book Notes to Book Reports

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

The Run-on Sentence: From Here To Eternity

If you find your sentences filled with commas, and they... Read More

The Write Habit: How to Strengthen Your Writing Muscle

Writing is a muscle that needs exercise to stay in... Read More

Writers Helping Writers - A Noble Legacy

It is satisfying to be a part of such a... Read More

An Introduction to Self Publishing Material

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

Have You Plotted Your Story Before Writing It?

Creative Writing Tips ?The writer, who doesn't have the time... Read More

Writer?s Web Resources

The Internet has truly revolutionized the careers of writers worldwide.... Read More

Get Noticed! Eight Tips to Catching an Editors Eye

The first five pages of a novel are critical.Editors make... Read More

The Writers Angst

What is this annoying, insidious angst that permeates my psyche?... Read More

Balance Your Life

Balance your life ... Read More

Create the Writing Life You Want

Ah, writing. For those of us who love to play... Read More

Aesop, Abraham Lincoln, and You

May I tell you about a writing technique shared by... Read More

How To Break Into Print Publishing

The big question. Do you submit directly to the publishers,... Read More

Nobody Likes A Rambler

We all know people who ramble. They include every boring... Read More

The Best Freelance Job Boards for Writers

How many times have you checked out a job board... Read More

10 Tips To Help You Pack More Power Into Your Business Writing

1. Before you write anything down define not what you... Read More

How To Be A Published (Non-Fiction) Author

1. Turning your idea into a bookWith non-fiction books the... Read More

10 Tips on Writing Effective Dialogue

1. Become an EavesdropperListen carefully to the way people REALLY... Read More

Writing Tips For Novice Authors

If you are reading this article then you probably have... Read More

Vary Your Writing Style and Win Readers

First drafts are for getting down the ideas. Anna Jacobs... Read More

Applying KISS Principle in Writing

I have added a new word to my vocabulary. Logorrhea.... Read More

New Year Resolutions for Writers - The Best Kind to Make and How to Keep Them

On the first day of a bright and shiny new... Read More

How To Write Thank You Letters With Class

When I first started tracking the information preferences of people... Read More

Before You Write Your Book, Organize Its Parts - Part 2

If you are a serious writer who wants to publish... Read More