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

---

Freelance or Staff

There is no doubt that a staff writer enjoys advantages... Read More

How to Write Your Op-Ed Piece

Op-ed articles, also known as opinion/editorial articles, are a great... Read More

Writing Without Style

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

Becoming a Writer

The urge to write fiction seems God given for some,... Read More

Bring Out the Natural Writer in You

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

Are You a Freelance Writer? - Then You Need a Website

As a freelance writer, it is important to present yourself... Read More

Plotting By Personality - Work With Your Natural Instincts

What's the best way to plot?Quick answer: the best way... Read More

Character Motivation - Always Ask WHY

For many years, I've been a tutor for students undertaking... Read More

Become an Instant Author by Playing Well with Others

You wrote a tips booklet. Maybe more than one. Oh... Read More

Top 10 Tips to Complete a Creative Writing Project Without Losing Your Creativity

Have you ever started a creative writing project with great... Read More

A Writers Tools

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

Pairs/Groups Of Words Often Confused - Part 3 of 6

ELICIT, ILLICITElicit means to extract or draw out; illicit means... Read More

Unusual Points of View

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

Writing For The Web: Where To Get Article Ideas

A friend and I were talking the other day about... Read More

How to Write Articles, Reports, and Books Quickly

Do you have trouble getting your thoughts and ideas down... Read More

Why I Write

I started writing as a way of keeping safe memories... Read More

Be Your Own Literary Agent and Get Published

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

Writing Personal Statements - Top Tips

WRITING THE PERSONAL STATEMENT TO GET INTO UK UNIVERSITYHOW DO... Read More

Write With Passion: 4 Steps To Emotionally Charge A Nonfiction Article

You have just completed a draft of an article. It... Read More

Mixing and Mingling: The Door to Publication?

Mixing and mingling with industry professionals is an opportunity that... Read More

Ferreting Out Work

FERRETING OUT WORK You keep hearing that there's work out... Read More

Get Creative In The Great Outdoors

Summer's here and the time is write for dancing in... Read More

Four Easy Ways to Get a Book Written (Especially If You Dont Like to Write)

Becoming an author is probably a lot easier than you... Read More

3 Tips to Achieve Your Writing Goals

1. Make your goals achievable.By achievable, we mean realistic and... Read More

8 Great Journaling Tips

Mix a martini, don't forget the olives, or pour yourself... Read More

Why Researching Is Good, And A Failure To Do So Is Not

What a lack of research could do to you.When creating... Read More

Writing With Power: 5 Snappy Rules For Success

Almost everyone could profit from enhancing their writing skills. From... Read More

Extreme Research: 10 Snappy Rules For Success

So you want to learn to research well, and not... Read More

Review In 29 Steps Plus One

I just finished to read a book. A story for... Read More

Get Your Writing Reviewed by Major Publications for Free

All Writers need the press, especially new writers. As a... Read More

Format Each eBook Chapter Before you Write It

Do you have a problem creating a focus in your... Read More

Bird by Bird

It's easy to feel overwhelmed by marketing. First, there's so... 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