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

Wood Dale Chicago prom limo .. Lockport Chicago limo O’Hare

In The News:

Fueled by artificial intelligence, CyberDog the robotic dog is designed specifically locate fire ant nests, which are endangering ecosystems.

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

Internet browsers are useful, but they can be dangerous. Clicking on malicious links can direct you to dangerous websites that steal information or infect your device.

Apple's latest iOS update introduces advanced artificial intelligence capabilities, which may be capturing and analyzing sensitive information.

Breach site confirmed 56,904,909 Hot Topic users' data leaked online. Tech expert Kurt “CyberGuy" Knutsson says the company's silence makes matters even worse.

Tech expert Kurt “CyberGuy" Knutsson discusses how an innovative Easy-Way kit turns standard strollers electric, simplifying navigation for parents.

Tech expert Kurt “CyberGuy" Knutsson talks about T-Mobile being hacked in broad cyberattack on global phone and internet companies.

Tech expert Kurt “CyberGuy" Knutsson shows you how to add, customize and manage widgets for quick access to apps and info from your iPhone home screen.

Wrong Google searches can not only compromise your device and personal data. They can also bring law enforcement to your doorstep. Hackers are targeting Google searches.

China's Shanghai Kepler Robotics has developed a new humanoid robot that can carry up to 35 pounds per hand for commercial applications across various industries

Checking your hearing has gotten easier with the new hearing test feature in AirPods Pro 2. You can take reliable hearing tests using your iPhone or iPad.

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 "CyberGuy" Knutsson explains how a VPN — virtual private network — works and how running it can slow down the operation of your device.

The WalkON Suit F1, an exoskeleton developed to help people with disabilities, can actually walk over to a person in a wheelchair, solving a major problem.

ClickFix, a new scam targeting computer users, is on the rise in the U.S. The scam prompts its targets to click on a link to fix a problem.

Skydweller is the world's largest unmanned solar-powered aircraft that can stay airborne for weeks, and even months, without refueling.

The U.S. government said it is investigating after People's Republic of China hackers targeted commercial telecommunications service providers in the U.S.

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

Scammers are using increasingly sophisticated ways to lure unsuspecting victims, and some are impersonating an email help desk or support team.

You can unsend or edit your iMessages with the latest iOS updates. Kurt the CyberGuy explains how you can save yourself some potential embarrassment.

Kurt “CyberGuy" Knutsson says there’s been a rise in cybercriminal services using hacked police and government emails to send subpoenas and data requests to U.S. companies.

Kurt “CyberGuy" Knutsson discusses how Axiom Space and luxury designer Prada are collaborating on NASA's Artemis III spacesuit design.

Voice assistants may cause confusion across devices. Tech expert Kurt “CyberGuy" Knutsson offers some solutions to fix it.

Shameless scammers trick veterans into giving personal info or cash. Tech expert Kurt “CyberGuy" Knutsson explores five common scams.