Maintain your old Siemens Hipath system

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

In The News:

Plunged into anarchy: Venezuelan city on edge after frenzied looting
Wed, 20 Mar 2019 13:35:00 +0000
Vigilantes are standing guard outside stores to prevent looting in Venezuela's second city, Maracaibo.

After days of darkness, mob's orgy of violence has left city in shock
Wed, 20 Mar 2019 14:43:00 +0000
There's still a palpable air of shock in Maracaibo.

As Mueller's two-year investigation ends, what could happen next?
Fri, 22 Mar 2019 21:04:00 +0000
Unlike so many things in Washington, Robert Mueller's investigation has generated very few leaks. 

The main players in the Mueller investigation
Wed, 27 Feb 2019 17:59:00 +0000
Robert Mueller has concluded his investigation into alleged Russian collusion in Donald Trump's 2016 presidential election campaign.

Helicopters struggle to deliver aid after roads washed off the map
Fri, 22 Mar 2019 20:34:00 +0000
The aid workers and emergency responders gathering in the central Mozambican city of Beira know exactly what to do when hundreds of thousands of people lack basic necessities like food, shelter and clean water.



tikatoshop.it

Erfahrungen mit Pallhuber Wein
Agen Bola SBOBET Terpercaya

Travel in comfort and at your leisure with CT Airlink Limousine & Car Service for top quality private transportation and exceptional customer service. We operate Sedans, SUVs & Vans for CT Car Services to covering all Connecticut airports including Car Service from CT to Newark Airport , Mohegan Casino Uncasville CT, Foxwoods Casino Mashantucket CT, Manhattan Cruise Terminal NYC, Brooklyn Cruise Terminal NYC and Bayonne Cruise Terminal NJ. CT Airlink hire licensed and friendly chauffeurs who have in-depth knowledge of the Areas.

Writing Business Letters That Get The Job Done

Despite the widespread use of e-mail in commerce today, traditional... Read More

Linguaphone Language Learning Solutions

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

How Can You Find Freelance Work As A Writer?

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

Generating Nonfiction Book Titles Without a Hassle

The process of developing a working title for your nonfiction... Read More

How NOT to Get a Freelance Writing Job

In the business of freelance writing, it's not enough to... Read More

Write a Letter, Make a Difference

Today I took the dog for a walk and realized... Read More

Scenes and Structure

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

Writer School?

Here's something from my mailbag. "Dear Michael, do you need... Read More

A Single Technique

Writing is hard work, and like all hard work, one... Read More

How I Became a Syndicated Columnist -- And You Can Too!

Real Estate has "Location, location, location," and writing has "Clips,... Read More

Strategies For Finding Topics To Write About

What possibly could I have to write about? I never... Read More

Top Ten Tips (Part 2)

Golden Rules For New Writers - Things you need to... Read More

Leveraging Your Writing

A frequent conversation I have with my writing clients is... Read More

Alternative View Points and the Lamp of Creativity

Pictures they say are worth a thousand words, but many... Read More

How To Self-Publish Your Own Books, Manuals, Reports Or Newsletters

You can make a lot of money by writing and... Read More

The Writing Life

In the 7th grade I wanted to be an architect... Read More

The Writer and the Web

If your dream is to get published, the chance is... Read More

Get Rich Writing With Your Computer Word Processor

Your computer is a writing machine, a word processor, a... Read More

A Writers Tools

William Faulkner, the great Mississippi writer, said, "The tools I... Read More

Essay Types and Modes Youll Need to Write for College

~TYPES~You Want Us to Write What? Understanding the Task AssignedWhich... Read More

The Three Cs of Writing an Excellent all Purpose Headline

Since the headline is the first contact your readers have... Read More

How To Cut the Clutter and Win Readers

Most of us hate housework.Nevertheless, even the most hopeless slobs... Read More

Untrue Father (A short Story)

Kallu was a tenant of Santosh Kumar Nayak. Santosh Kumar... Read More

How to Write Your Op-Ed Piece

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

Aesop, Abraham Lincoln, and You

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