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'.
MORE RESOURCES:
 |
|
|
RELATED ARTICLES
Writing Styles for Fiction: Which Voice to Use
I recently set up a website to promote a new suspense novel. Once it started receiving hits I began getting questions about why I chose to write in third person.
How to Publish a Book: Key Differences Between Publishing and Self Publishing
For many authors just starting out, it can be a confusing and overwhelming decision whether to self publish a book or to seek out a traditional publishing house. It is important to know that the decision you make can have a huge impact on the success, or the failure, of your book.
Be A Savvy Writer: Go Where The Business Is
If you're a writer, you're in business. It doesn't matter whether you're writing picture books, or a self-help book for underachievers, or promotional material and flyers for anyone who wants it.
Save Time When You Write
I'm in the process of moving from one computer to another, and one of the things I really miss so far is a good keystroke macro program.That's a program, a communication technology, that allows you to trigger long strings of text, including names and email addresses, with just a couple of keystrokes.
And What Do You Do? ... How To Know When Youre a Writer!
It's the funniest thing. When someone asks me what I do for a living, I tell them, "I'm a writer.
Top Ten Ways to Write Like a Pro Checklist
Sure you can write, but can you write crisp, compelling copy thatezine publishers, related Web sites, and book audiences willclamor for?
To sell well, your articles, reports, books, and copywriting need to pass the checklist below:
1.___Make your book or article title or headlines grab your reader by the collar.
Top Seven Ways to Select a Book Topic That Sells
Authors need to write their book according to their target audiences' needs and wants. You can sell many more copies when you address these seven ways to select a topic that sells.
The Writing Club
Typically when falling asleep in bed at night great thoughts enter the mind, long stringed and meaningful sentences trip over each other to receive attention at the front of the brain alongside all the brilliant findings, results, meanings that speak volumes and hard hitting phrases that are just the ticket to open the door to success. The last thought in the brain before sleep overrides this brilliant future work is, "must use that tomorrow".
Mama Dont Allow No Fighting in Your Writing
When you sit down to write a steamy romance, a spine-tingling horror story, or an action-packed adventure, lock the door. The last thing you need is your mother, father, coach, English teacher or pastor reading over your shoulder and giving you advice.
Screenwriting, Screenplays, Screenwriters - Incremental Productivity
When attempting to understand Creativity and Innovation, it pays to import the vast range of research and knowledge that has been accumulated in these fields - most of it is to be found in the field of Business and Management.For example, Writer's Block is intimately related to Organizational Culture - the same principles that prevent people from generating ideas in the corporate workplace are also responsible for Writer's Block - evaluation apprehension in its many forms.
Alternative View Points and the Lamp of Creativity
Pictures they say are worth a thousand words, but many writers know that they are worth much more than that!Without decent photographs or other artwork to accompany an article many features published in todays magazines and newspapers would never see the light of day, so it makes sense to try and supply illustrations along with your submissions.Last month's article gave some tips and advice on how to improve your camera wielding technique so click here if you missed it.
Make Your Readers Cry
You know, I really hate it when someone catches me crying over a book.I surreptitiously dab at the corners of my eyes with a finger.
Inspiring the Poet in You!
Poems. Just the mention of them makes me smile.
Grow Your Ideas Without Letting Words Grow Like Weeds
Q: How do I expand on an idea without getting too wordy?A. Before you begin counting words, focus on holding the reader's interest.
Top Seven Mistakes Writers Make and What to Do About Them
Writers often get stuck because they make assumptions about writing, finishing, publishing, and promoting their books. A recent client confessed that he thought a book was just too big a project.
Get An Attitude About Your Writing
(This excerpt is taken from my new writing workshop Writing To Sell In the Internet Age.)Writer John Clausen, in his excellent book about freelance writing: Too Lazy To Work, Too Nervous To Steal, recommends that you get an attitude about your work.
Web Writing: Create Writing Flow With Four Uncommon Connectors
Connectors -- conjunctions, punctuation, and transitional phrases -- allow readers to process information promptly by creating balance and relationships between sentence parts. The connectors are performing the same work as verbs, objects, modifiers and multiple subjects.
Writing the KAIZEN Way
Over the past eight years or so, I have tutored thousands of writing students. They come in all flavours: retirees who at last have time to satisfy a dream; young mothers who want a job they can do at home; bored workers who feel their creativity is being stifled by their existing careers.
Know Your Editing Choices
Each author has special editing needs. To save yourself time and money, look at the choices below and decide which kind of editing suits your needs.
Multiplying Sales As A Writer
Often, time is an enemy of writers. Sales seem slow and
checks too small.
|