| |
| |
|
Writing Information |
|
|
|
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:
Writing - Google News |
|
|
|
RELATED ARTICLES
Use Real-Life Templates For Writing Success At some point along the way, most of us have used what are commonly called "fill-in-the-blank" writing templates. We might have used them to write a letter, format an essay, or set-up a resume or CV. The Untold Secrets of Writing Best Selling Childrens Books Ever wondered how the most successful children's book writers get their ideas? The answer may surprise you.Most children's books are based on the same exact story - good versus evil. Writing Help Whether you are working for a small business, large corporation, or are a student, there are numerous sources that you can turn to for help with writing. Businesses need to be able to effectively communicate with their customers, their employees and their potential customers. What Can Go Into A Plot? Creative Writing Tips -We all tackle plotting differently. How you plot will be individual to you, as it is with every writer. 5 Effective Web Writing Tips Writing for the web is very different from writing for the print medium. Writing for the web requires some special abilities. Tips On Writing A Killer Sales Letter Writing a sales letter doesn't have to be that difficult all you need is the right writing style and some tips to knock out a killer sales letterBenefits The first thing you need to do is focus on the benefits the reader will find useful. Tell the reader what's in it for him. When I Grow Up I've just come back to work after nine glorious, sun-drenched days at home. This year, vacation was the week of July 4th. What Does It Take To Make Your Memories Into Publishable Memoirs? Why should you consider creating a memoir of your personal experiences for publication?Who would want to read your life story?I believe the main reason you may want to think about writing a memoir of your life is fairly simple. Everyone has different experiences in life that we learn from, that shape our lives, that hurt us, help us, give us insight, and allow us to grow. Freelance or Staff There is no doubt that a staff writer enjoys advantages not availed by the freelancer. However, there are benefits available to the freelancer that a staff writer can never expect. A Writers Tools If you are like most writers, you're constantly searching for tips on technique that will help you to increase your chances of publication. You eagerly pounce on articles that tell you how to plot better, write better and sell better. Best Writing Advice I Ever Got I've been in the communications business a long time?over 25 years. During that period I've gathered writing suggestions from all over, and put much of it in my new book "Words That Stick. A Writers Life Ever wonder what an author's life is like? What that breathing, sweating, hungry, weary, bona fide guy does when he's not at the keyboard? How does his "day job" affect his writing? When he's mowing the lawn, grocery shopping, or babysitting grandchildren - what goes through his mind? Is he sucking up every sensation as he moves through his day, tucking tidbits away for a future piece? Or, does he simply journey through life, just - doing - these things?How do I define myself? Am I Aaron Paul Lazar, with the obligatory middle name, author of the LeGarde Mystery Series? Sometimes. At book signings, indeed. Letter Writing Journaling When you read a letter from someone, we are immediately transferred into their world, experience, and physical reality. You can capture the same feeling by writing letters to yourself or about other people in your journal. How to Get Free Publicity in In-flight Magazines If you're targeting an educated, more affluent audience with your message, and your topic is a good fit, in-flight magazines can be one of your best publicity tools.A quick look at the statistics should convince you:--Many of these magazines have high circulations. Be Concise Concision. (Sounds like I made up another word. Is Someone Plagiarizing Your Work? About two weeks ago I received an article submissionthat immediately attracted my attention. The title wasidentical to the title of an article I wrote and whichwas published in 'WebProNews' in May 1999. Understanding The First Rule Of Writing - Before You Start The Great American Book Chaos and confusion come when established rules and procedures are not followed. Even mixing and matching systems to favor one's own position can cause a great deal of consternation. Ten Ways to Get Cheap (and Free) Magazine Samples 1 - Join a reading or writing group. Ask members to bring in their already-read magazines and have an exchange. Should I Keep Writing? Writers are an insecure lot.It's easy to understand why. Writing from Home: It Can Be Great and Not-So-Great for Mothers I went to school to be a teacher. In fact, I have a B.
|
| home | site map |
| © 2006 |
