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.

maide service in Lincolnshire ..

In The News:

Denmark's 3D-printed student village proves automation builds 36 apartments faster than traditional methods. Skovsporet project shows housing future.

Discover Android's new Sound Notifications feature that alerts you to smoke alarms, doorbells, and baby cries even when wearing headphones.

New SantaStealer malware reportedly threatens holiday shoppers with password theft. This Christmas-themed info-stealer targets browsers and crypto wallets.

The Christmas season brings a surge in Netflix phishing scams targeting shoppers with fake emails. Stacey P received convincing scam but verified account first.

San Francisco Giants invite Jamie Grohsong to throw ceremonial first pitch at Oracle Park after he learned to play baseball with a bionic hand following an injury.

FBI warns cybercriminals are stealing family photos from social media to create fake proof of life images in virtual kidnapping scams targeting victims.

Instagram's new 'Your Algorithm' tool lets you control your Reels feed in real time. The app now gives you power to customize what videos you see.

Major Marquis fintech breach exposes 400,000-plus Americans' data through unpatched SonicWall vulnerability, with Texas hardest hit at 354,000 affected.

Free up iPhone storage fast by clearing large photos and videos from Messages app. Simple steps for iOS users to delete attachments without losing chats.

Scammers are flooding inboxes with fake tracking alerts that mimic real carriers, exploiting the holiday rush to steal logins and personal data.

The Fox News AI Newsletter brings you the latest news on AI technology advancements and the challenges and opportunities AI presents now and for the future.

Texas family reunites with missing 11-year-old cat Grayson after 103 days using Petco Love Lost's AI photo matching technology and community help.

Tired of AI customer service loops? These insider tricks help you escape "frustration AI" and get real human help when you need it most for urgent issues.

Unlock richer audio from your streaming apps with simple tweaks to volume normalization, equalizer settings, and quality preferences for cleaner sound.

Scammers are sending fake Facebook settlement payout emails that mimic legitimate notices from the privacy settlement administrator to deceive users.

Holiday shopping scams surge as fake refund emails target distracted consumers during Black Friday and holiday seasons, costing Americans billions annually.

The AI-powered IRMO M1 exoskeleton features four modes, including turbo, eco, training and rest for hiking, running, cycling and sports with eight-hour battery life.

OpenAI announced upgrades for its ChatGPT Images platform on Tuesday, saying the program can now make more precise edits and produce images more quickly.

Chrome for Android now turns web articles into AI-powered podcast conversations. Get hands-free browsing with Google Gemini's natural audio summaries.

LastPass faces $1.6 million fine from U.K. regulators after 2022 data breach exposed 1.6 million users. Password manager failed proper security controls.

Petco disclosed a data breach exposing customer Social Security numbers, financial account details, and driver's license information due to a software error.

Baseball teams can now analyze complete swing mechanics in normal training environments using Theia's markerless AI system that processes standard high-speed footage.

Smart home hacking fears overblown? Expert reveals real cybersecurity risks and simple protection tips to keep your connected devices safe from hackers.

MIT develops needle-free glucose monitor using light technology. Revolutionary device could replace painful finger pricks for diabetes management.

The ClickFix campaign disguises malware as legitimate Windows updates, using steganography to hide shellcode in PNG files and bypass security detection systems.

The Value of Adding Images to Technical Documentation

Writing