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

---

Hero?s Journey ? The First Threshold

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

Put a Spin on Your Idea!

Eight or nine times out of ten, picking up and... Read More

Graphology - Unleash Inner Personality & Talent of Child

|| Graphology & Graphotherapy ||Everybody wants to know more about... Read More

2nd Installment on Autobiography

ESSAY 2Andre Malraux once said that what interested him in... Read More

An Inside Look at Proofreading

This is the ideal topic for us all to think... Read More

Sick of the Traditional Publishing Path?

A book coaching client recently emailed me that she was... Read More

Write For Yourself First

It would be very selfless or noble of me to... Read More

From Book Notes to Book Reports

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

Water to Swim In

Not long ago, I took stock of my unrealized desire... Read More

Creative Writing Tips - Have You Established Your Main Character At The Start?

In the beginning of your story you have to grab... Read More

Writers Block is No Longer a Problem

"If you're like me, than I'm sure you're pretty familiar... Read More

Building a Character Wall

For any great novelist, defining your cast of intriguing characters... Read More

Top 10 Common English Goofs by Web Authors

In reviewing and browsing web sites over the years, I... Read More

Editing

EditingExpect, allow, and accept that every first draft will represent... Read More

Basic Word Processing Tips for Writers

Word processors are so widely used now that I tend... Read More

Conflict - How To Keep Your Readers Turning Pages

Some writers are just too kind.They hate to put their... Read More

How To Be A Published (Non-Fiction) Author

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

Tell the World About You

You have a new website, or a new business, or... Read More

Masquerading As Novel ~ Can Author?s Work Convey Important Perceptions?

While novels do not usually attempt to convey concepts about... Read More

Increase Your Chances Of Winning Writing Contests

Winning writing contests can provide several advantages to writers. For... Read More

Power Writing 101: Tips and Tricks to Get You Taken Seriously!

In my ten years as an advertiser, I've encountered plenty... Read More

Revising Your Manuscript: Fourteen Questions to Ask Yourself

1) Can you summarize the story in about a sentence... Read More

The Authors Life: 14 Hints on Creating a Career Plan

1. Remember publication is a business; writing is an art.... Read More

A Quick Guide to ISBNs for Self-Publishers

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

9 More Writing Tips for Successful Email Marketing

A few months ago, I wrote a guide entitled: 101... Read More

The Unwritten World Of The Reality Of Letterwriting

You may wonder why I have chosen this title of... Read More

How to Outline your Book and Chapters with Mindmapping

Mindmapping is better than linear outlining because authors can use... Read More

Documenting Everything: Your Journal is Your Logbook

Sailors had it for years. Great explorers had it as... Read More

Freelancing Doesnt Mean Writing For Free. Does it?

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

Making Money from Freelance Writing

Making Money from Freelance WritingIt's the question that every aspiring... Read More

Write Your Story, Put It On A Website, Sell Millions of Copies

Although he has his own website, John Grisham probably does... Read More

Amazing Ways Writing Articles Can Improve Your Business

How to get a lot of traffic to your website... Read More

Journaling

How many of you take the time to really write... Read More