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 email@example.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'.
The Blank Mind
Many writers stare at the blank page or clean computer screen and wait for inspiration with a feeling of hopelessness. That white page or screen is always a struggle to fill, and it probably will always be for most writers.
The Iniquitous Slip
All the famous writers I heard of could paper the walls of their offices with rejection notices.
Top Ten Tips (Part 2)
Golden Rules For New Writers - Things you need to know before you begin.
Formats for Writing Life Narratives
Q and A.
Writing For the Joy of It
As a child, I loved to write. I can't remember ever not writing.
Writing HI-LO Material (High Interest, Low Ability) for Slow Readers
To write books for readers at an elementary reading level (for either adults or children) you start off exactly the same way as you do any other book: you work out a strong plot and people it with interesting characters.
Top 7 Writers Sites for 2005
If you dream of turning your book into a best seller, or you're looking to become a best selling author in your field, then these sites promise to help you do just that.
Check Your English Grammar With This Easy Technique
As an International language, English has been used widelyin online world. Whether you use it to write a sales letter, afollow up, ads headline, an article, and so on, youneed to use it correctly.
Making Better Word Choices ? 4 Examples
Choosing the wrong words can have a poor effect on your writing and on you. Whether you are writing a cover letter for a job, a business proposal, or an application essay for graduate school, using words poorly can result in negative feedback. One could find entire books regarding word choices for writers; this article will touch on some fundamental, but important ways to choose the correct word for your situation.
What You May Not Learn In College... (Part Two)
If you become a writer for any publication, private business, public entity, non-profit organization and/or large corporation that employs more than one editor, you may find that your job description, expected contributions, desired writing style and similar "guidelines" for your position - are subject to change daily/weekly/unpredictably - according to each editor's mood and/or personal preferences.
A Few Keys to Writing Effective Dialogue
Every writer expends a great deal of creative energy developing a story line and limning well-balanced prose with evocative sentences. That's what writing is all about, after all. But fiction writers have an additional aspect to creation--effective dialogue. Very few stories, novellas or novels are without dialogue, and for some writers, this can be a stumbling block.
On Writing and Poetry: Harry Calhoun in Conversation
"This is just brilliant. The whole interview is incredible? I'm? REALLY appreciative of some seriously good advice from a fellow writer." Mark Howell, Senior Writer, Solares Hill
An Inside Look at Proofreading
This is the ideal topic for us all to think about. We do it everyday, especially those of us that use the Internet the majority of the time. Web pages, business letters, articles, news releases, documentation and most certainly, advertisements.
Writing the PDA Way
When we think of writing it triggers many thoughts and visions depending on our framing. It could trigger a lone man with a full astray, unshaven, staring at an old plunking typewriter with white blank crisp paper waiting in anticipation for his words.
How to Come Up with Fresh Story Ideas
How to Come Up with Fresh Story Ideas When Your Well has Been Tapped Dry
Gut Check: Quitting Your Full-time Job for Your Freelance Career
It's 6:00 p.m. You're dead tired, but instead of an early night, you go to your "second job" - your freelance business.
Business Writing: 10 Great Authors
Great business writers combine narrative skills with sound judgment to create classics that help both the beginner and the mid-career professional.
Self-examination sheds light on a writers motives, goals, and aspirations, while self indulgence hide the obvious and absorbs any illumination before it occurs.
Amazing Ways Writing Articles Can Improve Your Business
How to get a lot of traffic to your website FREE? Writing articles. This is one of most cost effective way to promote your website - it saves you a lot of money, in the meantime, you get a lot of valuable visitors. The following are a few tips for your reference.
Writing Query Letters
A QUERY LETTER is written to an editor or agent to describe a piece of writing to ask if they'd like to see it. It is sent in lieu of an unsolicited (unasked for) manuscript. (A COVER letter is a letter sent to ACCOMPANY a manuscript.)
|© Athifea Distribution LLC - 2013|