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.

Olympia Fields cheap limo service .. Lockport Chicago limo O’Hare

In The News:

Tech expert Kurt “CyberGuy" Knutsson says Hipshipper, which is used by eBay, Shopify and Amazon sellers, exposed millions of shipping labels.

Boxabl’s Baby Box is a 120-square-foot foldable home that can be set up in 60 minutes and has off-grid features. Kurt “CyberGuy" Knutsson says it's designed to maximize functionality.

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

Major IoT data breach: Mars Hydro database with 2.7 billion records exposed. Kurt “CyberGuy" Knutsson says the breach is a reminder of the risks that come with using IoT devices.

Unitree H1 robots dance at gala, blending AI and tradition. Tech expert Kurt “CyberGuy" Knutsson examines the convergence of cutting-edge technology and traditional culture.

For the first time ever, SpaceX launched a rocket into space from Florida and landed the booster the Bahamas, allowing for future polar-orbit spaceflight missions.

Attackers use caller ID spoofing and AI voices to steal money. Tech expert Kurt “CyberGuy" Knutsson provides seven ways to protect yourself.

Tech expert Kurt “CyberGuy" Knutsson talks about the Genesis GV60 MIV, an electric rescue EV with snow tracks for extreme missions.

Tech expert Kurt “CyberGuy" Knutsson helps you ensure a smooth online experience with a reliable, secure home network setup.

Kurt “CyberGuy" Knutsson talks about Vollebak’s Shielding Suit, which blocks EM radiation, infrared and tracking for privacy.

Even Apple products are vulnerable to cybercriminals, and a new report suggests the owners of Mac products will have to be more vigilant this year.

An inflatable six-person tiny house from a firm called 2001 looks like a space station with its inflatable dome that is transportable and eco-friendly.

Scams cost Americans an estimated $159 billion every year and average about $3,500 in losses per victim. The CyberGuy has advice to protect yourself.

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

Zeekr and Waymo are joining forces for the world's first mass-produced autonomous vehicle, combining an electric vehicle with self-driving technology.

A humanoid robot training center has opened in Shanghai, a big step in China's efforts to become a global leader in robotics and artificial intelligence.

Security experts have discovered that hackers are targeting apps on the App Store to spread malware that steals information from saved screenshots.

A new luxury SUV combines military-inspired design and high-end luxury transportation and includes two military-grade gas masks to protect against chemical warfare.

80% of stalking victims are tracked using tech. GPS trackers, like AirTags, are among the most popular ways to do it. Here's how to protect yourself.

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 to protect yourself against artificial intelligence-fueled romance scams, which have become the most common type of fraud in 2025.

Kurt "CyberGuy" Knutsson explains the steps to declutter text messages on a Mac or iPad. Apple offers ways to do this more efficiently.

Here's how to take control of the algorithms on Facebook, YouTube, Instagram and TikTok if your social media feeds aren't showing you content you want to see.

Beware of iCloud scams using urgent messages. Tech expert Kurt “CyberGuy" Knutsson helps you spot the red flags to protect yourself.

Travel abroad worry-free with these top translation apps for travelers. Tech expert Kurt “CyberGuy" Knutsson highlights some favorites.

The Value of Adding Images to Technical Documentation

Writing