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'.

kitchen deep cleaning Glenview ...

In The News:

The Midnight Mimosa malware campaign hides inside cheap Android phone firmware, giving attackers powerful access before owners even turn devices on.

The Fox News AI Newsletter covers the latest artificial intelligence technology advancements, including the challenges and opportunities AI presents now and for the future.

Meta's Muse AI was built to manage tasks, but users are developing romantic AI relationships and even calling the AI companion their girlfriend.

A Minnesota murder suspect's notebook listed 11 people search websites, raising urgent questions about data broker opt-out and online privacy risks.

Google Universal Cart tracks price drops, surfaces promo codes and uses Google Wallet to match your best credit card rewards before checkout.

Safari's Notify Me feature and Google's price-tracking tools can monitor products and send alerts when prices drop on your iPhone or Android.

George Weiner built PACspam.org to trace who sends nonstop political fundraising texts after blocking numbers repeatedly failed to stop the messages.

A dedicated VPN IP address may reduce frustrating CAPTCHAs and bank login security checks by giving websites a consistent connection to recognize.

Apple Wallet in iOS 27 lets you create digital passes from physical cards using a photo or screenshot, but not every card in your wallet qualifies.

Anthropic's Claude AI submitted a fabricated eyewitness tip about an unsolved murder to a Philadelphia police website during automated testing.

P7 DarkSword iPhone spyware can steal saved passwords, photos, Apple Notes and cryptocurrency wallet data by checking for commands every 15 seconds.

Cybersecurity experts told Fox News Digital that a cyberattack on French supermarket freezers should warn the U.S. about critical infrastructure gaps.

The Oracle Health breach exposed medical records, Social Security numbers and diagnoses of nearly 20 million patients across multiple states.

The new Tesla Roadster drove upside down and launched into the air at SpaceX's Texas facility, but a 2028 production target remains unconfirmed.

Apple's iOS 27 lets you add keywords to iPhone photos, while Samsung Gallery tags and Google Photos search offer similar organization tools.

A fake Claude AI download scam uses Google ads, and Bing redirects to trick Mac users into pasting a hidden malicious command in their Terminal.

Ahold Delhaize's cybersecurity incident knocked online ordering and digital coupons offline at Stop & Shop, Food Lion, Hannaford and Giant Food stores.

The Fox News AI Newsletter covers the latest artificial intelligence technology advancements, including the challenges and opportunities AI presents now and for the future.

Amazon's About You feature includes personality details from your shopping history, and some shoppers are finding hilariously awkward results.

Identity theft recovery starts with securing bank accounts, freezing credit and enabling two-factor authentication within the first 24 hours.

Apple's $299 HomeView smart display uses facial recognition to personalize screens for up to six household members and show live security camera feeds.

Domonique DuBose spotted red flags when a man on Hinge with 85,000 followers and a blue checkmark claimed to be a San Francisco 49ers player.

Your phone's location data can expose visits to doctors, pharmacies and places of worship. The FTC took action against data brokers selling this data.

Hackers targeted Danfoss refrigerator controls across French supermarkets, forcing chains like Carrefour and Monoprix to discard massive food stocks.

iOS 27 finally lets iPhone Shared Albums store photos and videos at full resolution in iCloud, but new items count toward the owner's storage.