Home
>
Writing
>
Dont Forget That Manual!

Dont Forget That Manual!

No user manual? Surely you jest!

It may seem comical, but it's a surprisingly common situation. I've encountered many companies that don't provide any user manuals with their products. If they do, their manuals are often horribly incoherent, or else years out of date. It shouldn't happen, but it happens all the time.

Now, this problem is less common when buying off-the-shelf software or consumer electronics. That's because these products typically come from large corporations that pay attention to such details. Among smaller engineering firms though, this is a frequent occurrence. In fact, I'd estimate that about half of the small engineering companies that I've encountered are guilty of this offense.

I remember how one engineer told me why his company didn't provide any user manuals with their products. In hushed tones, he said, "It's because we don't make any money by writing manuals. It's not a money-making venture, so our management doesn't want to waste time on this." An annoyed expression crept into his face, then he leaned closer and said, "We have lost so many customers because we don't have decent documentation. Talk about being penny-wise, pound-foolish!"

It's not just the customers who suffer when manuals are inadequate or non-existent. What about the employees themselves? What happens when a new engineer comes on board, and has to learn quickly? Or what happens when existing engineers need to familiarize themselves more with unfamiliar aspects of their product lines? The user documentation, if properly written, can provide a gentle and efficient way of bringing the up to speed. Without it, they will be forced to rely more heavily on other engineers to educate them, thus wasting the time of everyone concerned. Weeks, if not months, of valuable manpower can be squandered in this fashion.

At times, a company will pay lip service to user documentation by slapping together some hastily written document that is difficult for a new user to digest. "Who cares about wording anyway?" I've heard many engineers say. "We're not writing poetry or screenplays here. What matters is that the manual must be technically accurate."

This is an appallingly short-sighted view. Technical accuracy is indeed important, but so are presentation and style. Few engineers would listen to a job applicant who shows up in a bathrobe and slippers, or a litigation attorney who speaks like a valley girl-and yet somehow, these same engineers expect their customers to slog through pages of meandering, poorly phrased text. Even matters as fundamental as spelling, grammar and proofreading are often treated as mere annoyances-piddling details that are worth nothing more than a cursory glance.

(To my relief, I have not encountered any such attitudes at my place of employment. I hasten to say this, lest anyone think that I'm complaining about the people that I work with! No, I've found that we all appreciate the value of excellence, for which I am always thankful. But I digress.)

Mind you, I understand that there are times when a company might not choose to invest an all-out effort in user manual development. This can happen during the early startup stages, for example, when manpower is in short supply and the products are still undergoing refinement. Unfortunately, many small companies never grow past that stage. Even after many years, they continue to thinks of user documentation as a trifling detail which deserves only a modicum of effort. By perpetuating that mindset, they ultimately shortchange both the customers and themselves.

Like it or not, a company's user documentation (or lack thereof) is a reflection on the company itself. You can be sure that your customers will notice if the user manuals are poor or non-existent. In today's busy world, where people need to absorb information as efficiently as possible, the lack of quality documentation can be nothing short of disastrous.

About The Author

V. Berba Velasco has been plying his trade for nearly a decade. During that time, he has repeatedly discovered the importance of good technical writing, and the pitfalls that can occur from ignoring its value.

Dr. Velasco currently works as a senior electrical and software engineer for Cellular Technology Ltd (http://www.immunospot.com, http://www.immunospot.com, http://www.immunospot.com). Dr. Velasco takes great pride in the company's commitment to user-friendliness and product excellence.

limo prices to midway Harrods Creek .. Lockport Chicago limo O’Hare

In The News:

Tech expert Kurt “CyberGuy" Knutsson says DNA tests pose privacy risks like shared genetic information, inaccuracies and hard data deletion.

Tech expert Kurt “CyberGuy" Knutsson says this enormous airship revolutionizes cargo transport by flying to remote areas.

Understanding the language of the internet can help you protect your personal information from bad actors. Kurt "CyberGuy" Knutsson explains.

Woven City is Toyota's experimental city that is a fully functional environment for people to live, work and play while doing research.

The line between spam and scams is thin. Kurt "CyberGuy" Knutsson details his tips for identifying and avoiding phone scams, robocalls and unwanted solicitations.

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

Kurt the CyberGuy takes you through the steps to easily set your preferred web browser whether you're using a Mac, Windows PC, iPhone or Android.

Google, Instagram, Facebook and weather apps can track your location and use that data to serve you ads; here's what you can do to protect your privacy.

A new debate has emerged about whether airlines should charge passengers based on their weight to help reduce fuel consumption and lower emissions.

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.

Dont Forget That Manual!

Writing