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:

Drug lord El Chapo set to die in jail after getting life sentence
Wed, 17 Jul 2019 12:07:00 +0100
Mexican drug lord Joaquin 'El Chapo' Guzman is likely to die in jail after being sentenced to life plus 30 years for smuggling drugs into the US over a violent, decades-long career.

UK carbon emissions target 'doing more harm than good' - Thunberg
Wed, 17 Jul 2019 11:28:00 +0100
Teen climate activist Greta Thunberg has told Sky News that the UK's pledge to produce net zero carbon emissions by 2050 is "actually doing more harm than good".

Man convicted of British teen's rape and murder in Goa
Wed, 17 Jul 2019 13:40:00 +0100
A beach shack worker has been convicted for the 2008 rape and murder of British teenager Scarlett Keeling in Goa, India.

PM 'extremely concerned' for Nazanin after mental health ward move
Tue, 16 Jul 2019 21:20:00 +0100
Theresa May has said she is "extremely concerned" about the welfare of a British-Iranian woman jailed in Iran after she was moved to a mental health ward.

Hong Kong's elderly march in support of young protesters
Wed, 17 Jul 2019 13:41:00 +0100
Senior citizens in Hong Kong have taken to the streets in support of the youths at the forefront of month-long protests against a widely-hated extradition bill.



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.

For Beginners: Ten Ways To Prepare To Get Published

(Skip directly to ten for the fastest shortcut!)Like any field,... Read More

Does Your Story Have A Theme?

Creative Writing Tips ?It should.A theme is a one-line explanation... Read More

Rules for Getting the Story Down

1. Write it fast, fix it later.2. Commit to writing... Read More

Writing Tips For Novice Authors

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

Increase Your Web Traffic By Using Keyword Articles

If you have an online home based business you know... Read More

Writing Tips for your Journey

Tips for your writing journeySo, you'd like to be a... Read More

Get Published: The Nuts and Bolts of Good English, and How to Impress a Publisher (1)

Not all writers write good grammar. That's a fact. It's... Read More

How To Write Thank You Letters With Class

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

Writer?s Web Resources

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

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

ACCEPT, EXCEPT Not commonly seen even from unpublished writers, who... Read More

Can Your Theme Be Proved In Your Story?

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

Writing and Self-examination

Good writing requires self-examination. Why is one writing? What part... Read More

Does Your Theme Contain Character, Conflict, Resolution?

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

Interview with Suspense Author Peter Abrahams

Peter Abrahams is the author of thirteen novels, including "The... Read More

New York Code Orange Jaisini New Art Series

The creativity of Jaisini is not designed to be preaching... Read More

Is The Theme Running Throughout The Story?

Creative Writing Tips ?It's no use coming up with a... Read More

An Introduction to Self Publishing Material

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

To Tell If You Are A Literary Snob

"I don't know if I should put 'writer' on my... Read More

Top 5 Rules of English Grammar

Communication is effective when we follow certain rules. These rules... Read More

A Beginners Guide to Writing a Novel

No one is born a novel writer. But do you... Read More

Get Rich Writing With Your Computer Word Processor

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

Pages: Your Book of Life

Many of us dream of writing a book. Why not.... Read More

Create the Writing Life You Want

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

Memories Dont Fade Like Hair Does: Memoir Writing Help for You, Our Elders, to Tell Your Story

~~~Old age, to the unlearned, is winter; to the learned,... Read More

Blank Mind, Blank Screen: Need Ideas!

Q. I'm staring at a blank screen with an equally... Read More