Writing Helpful Help – A Minimalism Checklist
?>
Download eBooks and Software
 The World's #1 Lottery System For Lotto.
Ken Silver's Multi-million Silver Lotto System! 1 Minute Setup, Winning 9 Out Of Every 10 Games Since 1991. Affiliate Commission Now 75%! Earn Up To $243/sale. Low Refunds. Visit: www.lottoaffiliatecenter.com
The Lotto Black Book
This Radical Approach To An Online Sales Letter Converts In The 3-5%... We've Never Seen Something Like This Since The Early Days Of 2004-2005 And I'm Sure You Haven't Either... We Convert More Than Our Competition And We Pay Out More... Try It!
Paleo Recipe Book - Brand New Paleo Cookbook
Brand New Paleo Diet Cookbook With Over 370 Recipes. Pays 70% Commission On This High-quality, Easy To Sell Product. Get Banners And Promotional Material At Http://paleorecipebook.com/affiliates.html
Articles > Computers and The InternetWriting Helpful Help – A Minimalism Checklist
by: Glenn Murray 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! ?>
News on Computers and The Internet
Google: Up to 500,000 Computers Face Disconnection From The Internet
On Tuesday internet services giant Google began warning users infected with the DNSChanger malware that they face disconnection from the web if they don't disinfect their computer. Facebook And Smartphones Becoming New Tools For Psychological Science Research
In today's technological era, most people use computers or smartphones to keep up with friends on Facebook, play games, etc. Psychological researchers have now discovered in two recent studies that social media and technology reveal a lot about someone's personality and the way they think. The studies, featured in the journal Perspectives on Psychological Science, describe how media and ... Yahoo seeks to shake up search, Web browsing
Joining the battle to redefine Internet search, Yahoo is taking aim with a new browser enhancement it calls "Axis." Hands-on: Yahoo’s Axis Browser
Yahoo’s Axis browser is fast and simple to use and the read later syncing feature across devices works as advertised, but it’s not a new idea. Google clears key mapping software for Syria
Google announced that its mapping software and other products would be available in Syria after getting export approval by the US government.
|
