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.

Lincolnshire shuttle from Midway .. Lockport Chicago limo O’Hare

In The News:

Most cameras allow you to instantly transfer images from a camera to a smartphone via Bluetooth, and you can print photos directly from your phone.

Security researchers have found a fake app pretending to be a version of the messaging app Telegram, and hackers are using the app to spread malware.

Meta recently announced it will cease working with third-party fact-checking organizations to flag misleading posts on Instagram, Facebook and Threads.

Scientists have developed a floating solar still device that is capable of harnessing the sun's energy to purify seawater and withstanding harsh maritime conditions.

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

Tech expert Kurt “CyberGuy" Knutsson says business email compromise scams are a serious threat, as shown by Teresa W.'s near loss of thousands of dollars.

Big tech coming in 2025 includes solar umbrellas, AI TVs, smart earbuds and crazy robots. Tech expert Kurt “CyberGuy" Knutsson gives his take on the wonders revealed at CES 2025.

Tech expert Kurt “CyberGuy" Knutsson provides two methods to restore your contacts for iPhone and Android devices.

FBI warns that criminals are using generative AI to exploit individuals with deceptive tactics. Kurt “CyberGuy" Knutsson explains their tactics and how to protect yourself from them.

Tech expert Kurt “CyberGuy" Knutsson says hackers are embedding dangerous code in Chrome extensions to steal your data.

Google Maps Location Sharing is now built into Android settings; no need for Maps settings. Tech expert Kurt “CyberGuy" Knutsson discusses the welcome improvement for Android users.

Not all apps out there offer legit virtual private networks, according to Kurt the CyberGuy. He explains how to keep your information safe.

Apple's Image Playground transforms text prompts into images or animations in seconds, brining a world of creativity to the palm of your hand.

NASA's Ingenuity helicopter, which flew on Mars in April 2021, became the first aircraft to achieve powered, controlled flight on a planet other than Earth.

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

Thieves who have iPhones can usually detect a hidden AirTag in vehicles they are attempting to steal, and an RFID wallet may not help you.

Genmoji, the latest addition to Apple's Apple Intelligence suite, uses artificial intelligence to generate customized emoji based on text descriptions.

It's easy to find yourself swamped in unread emails. Here are a few simple steps to archiving them and clearing out some of your digital clutter.

Keep your retirement plan safe from data brokers selling your personal information. Kurt the CyberGuy explains how to protect yourself and your retirement.

Turo faces scrutiny after tragic incidents involving rented vehicles, raising questions about security measures and regulatory frameworks.

A Chinese company has developed a spherical, 276-pound law enforcement robot that has been chasing down criminals at impressive speeds.

Here are some powerful online sleuthing tricks you can use to check the credibility of a website, see old pictures of places you've lived and even learn more about your neighbors.

Beware scam calls: Avoid unknown numbers and protect your personal information. Tech expert Kurt “CyberGuy" Knutsson talks about the increasingly common scam.

Tech expert Kurt “CyberGuy" Knutsson helps you crush your New Year's goals with these 12 apps to help you stay on track and succeed.

There are many untapped safeguards and tips you can learn to take your Wi-Fi knowledge to the next level, technology expert Kim Komando shares her tricks.

The Value of Adding Images to Technical Documentation

Writing