Home
>
Writing
>
Writing Helpful Help ? A Minimalism Checklist

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 seo copywriter. He is a director of seo copywriter and also of copywriting studio Divine Write. He can be contacted on Sydney +612 4334 6222 or at seo copywriter. Visit http://www.divinewrite.com or http://www.publishhub.com for further details, more FREE articles, or to purchase his e-book, 'SEO Secrets'.

Twin Lakes rental limo .. Lockport Chicago limo O’Hare

In The News:

The White House launched a new cybersecurity safety label, the U.S. Cyber Trust Mark, intended to help consumers make informed decisions on smart device safety.

Today's tech can help make life so much easier — if you know how to use it. Here are a few tips on the quickest and best ways to make your phone, laptop and other devices work for you.

Tech expert Kurt “CyberGuy" Knutsson offers Windows 11 restart fixes: Update drivers, run system scans and check hardware.

Sony and Honda's Afeela 1 EV launches with advanced tech and entertainment for $89,900. Tech expert Kurt “CyberGuy" Knutsson gives his takeaways.

With limited hard drive space, tech expert Kurt “CyberGuy" Knutsson offers these tips for storing large video files and photos.

Tech expert Kurt “CyberGuy" Knutsson says the $236,000 Yangwang U9 electric hypercar boasts 1,287 horsepower and can jump obstacles.

Flip phones are harder to block spam calls from, but it's not impossible. Kurt the "CyberGuy" explains how to stop incoming robocalls on your flip phone.

With so many notifications buzzing our phones these days, it's tough to distinguish between legitimate messages and possible scams. Kurt the CyberGuy helps unravel the mystery.

Scammers have a new trick where they pretend to be job recruiters to plant malicious apps on your devices. It all starts with a deceptive email.

Stay up to date on the latest AI technology advancements and learn about the challenges and opportunities AI presents now and for the future.

Kurt the CyberGuy breaks down why those emails that warn that "Your Apple ID has been disabled" is most likely a scam. Here's how to protect yourself.

Even small mistakes can negatively impact your credit score; here are some of the most common credit report errors and how you can fix them.

Tech guru Kurt "CyberGuy" Knutsson explores the many different ways you can repurpose that old iPhone of yours rather than trashing it.

A pioneering artificial intelligence and robotics company from China has developed a repository of over 1 million robotic movements to provide robotic training.

Kurt "CyberGuy" Knutsson reveals the warning signs and steps to take if you suspect that your personal computer is infected with a virus.

Researchers found in a study that users of a robotic prosthetic hand could successfully grasp and move two objects at once without dropping them.

The James Webb Space Telescope captured photos of one of the earliest supernovas ever seen using infrared technology, and creating a time lapse of the phenomena.

Stay up to date on the latest AI technology advancements and learn about the challenges and opportunities AI presents now and for the future.

New Mac malware variant targets browser credentials and personal data, researchers find. Kurt “CyberGuy" Knutsson gives tips to safeguard your Mac from the latest malware threats.

The Jetson One eVTOL showcases air racing potential, ushering in a new aviation era. Tech expert Kurt “CyberGuy" Knutsson says the race for eVTOL supremacy is just beginning.

Tech expert Kurt “CyberGuy" Knutsson reveals that hackers stole data from Gravy Analytics, a major seller of smartphone location data to the U.S.

Kurt “CyberGuy" Knutsson: If you just bought a new iPhone, here’s what to do first when you fire it up.

AC Future and Pininfarina unveil AI Transformer homes, merging sustainability and innovation. Kurt “CyberGuy" Knutsson says this could change the way we think about home.

Technology expert Kim Komando shares her easy tips on how to declutter your phones, computers and devices from the files you no longer need.

Tech expert Kurt “CyberGuy" Knutsson has the details on a Volkswagen data leak that exposed the personal data of around 800,000 EV owners.