Home
>
Writing
>
The Value of Adding Images to Technical Documentation

The Value of Adding Images to Technical Documentation

It's clich?, but true-a picture does paint a thousand words. This is an important message to remember when writing any sort of user documentation, such as an installation guide or an instruction manual. A document that makes judicious use of images and diagrams will be much easier to understand than one that is composed entirely of text descriptions.

I observed this first-hand years ago, when a junior programmer at one company was asked to update the software installation manual for their machine controllers. One of the first things he did was to strip away all the screen capture images, reducing the entire document to plain text. "These images are just silly!" he said. "They take up space, and they're just not necessary. I trust that anyone who reads this document will be smart enough to figure it out."

This turned out to be a huge mistake. The technicians who had to use the manual had a difficult time making sense of its instructions. They had to repeatedly ask for clarification, and one of them told me that the pure text descriptions were just too cumbersome to follow. They were fearful of using these instructions at all, knowing that a single misstep could lock the controllers into an irrecoverable state. It was a ugly situation all around.

The problem was that this programmer didn't try to make things easy for the users. For one thing, he failed to consider that some technicians were not native English speakers, and that they might struggle with the wording. More importantly though, this programmer expected too much from his audience. He wanted to reduce these instructions to their bare essentials, thinking that would be adequate. He failed to consider that even an intelligent, otherwise careful reader might be tempted to jump over instructions, or would gloss over some critical detail. This is a common pitfall when time is short, and when the users are confronted with pages and pages of bland text.

A few carefully chosen images, with suitable captions, can go a long way toward preventing that. When I saw that the junior programmer was stripping away all the screen capture images, I cautioned him against that. "These images may not be strictly necessary," I said, "but they help clarify a lot of details. For one thing, they show the user exactly which button to push, or which window to select. This makes the instructions much easier to understand, and reduces the likelihood of a human error." To this day, I wish that he had heeded my warning.

Were the users intelligent enough to understand the manual, as he claimed? Certainly-but intelligence is no guarantee against human error. Could the images have been construed as talking down to the user? Perhaps-but in my experience, sophisticated users seldom respond that way. Rather, most of them seem to understand the value that these images bring to the table. Perhaps it's because most of them know what it's like to be frazzled and pressed for time, and how easily important details can be lost in the text.

So remember-a picture paints a thousand words, and a single screen capture can be worth more than a dozen pages of text. It's a lesson that's worth learning.

V. Berba Velasco has a doctorate in Electrical Engineering and has been practicing his trade for nearly a decade. During that time, he has repeatedly found that good technical writing skills are almost as critical as good engineering skills. Dr. Velasco currently works as a senior electrical and software engineer for Cellular Technology Limited (http://www.immunospot.com), a biotech company in Cleveland, Ohio.

cheapest limo Akin .. Lockport Chicago limo O’Hare

In The News:

Tech expert Kurt “CyberGuy" Knutsson says using outdated computers and software leaves them vulnerable to security risks and malware.

Tech expert Kurt “CyberGuy" Knutsson reveals how WalkON enhances walking and jogging with sensors and artificial tendons.

Old-fashioned check fraud is back in style, quintupling over the past year. Here are a few low-tech, practical means of protecting yourself.

Tech expert Kurt “CyberGuy" Knutsson discusses how 600,000-plus records, including checks and property data, were left exposed online by an information service provider.

That weird text from a friend may actually be from a hacker. Kurt “CyberGuy" Knutsson tells you what signs to look out for.

Scammers can wreak havoc on your life just by having your phone number. Kurt "CyberGuy" Knutsson addresses how to avoid becoming a victim.

PongBot is an artificial intelligence-powered tennis robot and a smart training partner available to play 24 hours a day, seven days a week.

Kurt "CyberGuy" Knutsson explains how to update your iPhone to add Apple Intelligence, which he says can transform your interactions with your phone.

University scientists have trained a robotic surgical system to do work with the skill of human doctors, possibly transforming the future of surgeries.

As more companies implement artificial intelligence for daily tasks, some industry leaders are working to push back against certain aspects of the technology.

Tech expert Kurt “CyberGuy" Knutsson says the Batagaika crater in Siberia expands 35 million cubic feet yearly due to thawing.

While fewer than 30% of farmers reportedly use emerging technologies like artificial intelligence, experts believe AI could help producers and farmers make food quicker and more efficiently.

Amazon becomes a prime target of scammers during the holiday shopping season trying to steal Social Security numbers, bank information and Amazon credentials.

Spammers have found a way to target Spotify playlists and podcasts to push pirated software, cheat codes for games and spam links and malware sites.

Sharing information online like your vacation plans and relationship status can make you a target for scammers; here's what to avoid posting to keep yourself safe.

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 explores six sneaky holiday season gift card tricks, providing tips on how to outsmart scammers trying to rip you off.

Apple Watch's Translate app gives you your own personal interpreter, allowing you to have live two-way conversations in up to 20 different languages.

With kids facing a seemingly increasing amount of threats from creeps on the internet, here's how you can respectfully ask people not to post photos of your children on social media.

Tech expert Kurt “CyberGuy" Knutsson reveals how to regain your Facebook access if you get hacked or locked out.

Kurt “CyberGuy" Knutsson explains how to safeguard retirement accounts from cyber threats with a VPN: encryption, anonymity, secure access.

I’m going to Europe soon, and planning my trip was a breeze. Yes, really! AI did a big chunk of the work for me — and it can help you plan your next getaway, too.

Tech expert Kurt “CyberGuy" Knutsson says North Korean hackers hide malware in macOS apps, bypassing Mac security checks.

Kurt “CyberGuy" Knutsson reveals how iPhone’s new Automatic Mic Mode adjusts settings for optimal call quality automatically.

Jeff Hancock, an expert on AI and misinformation, has been accused of fabricating an expert declaration by citing a study that was allegedly made up by AI.

The Value of Adding Images to Technical Documentation

Writing