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.
shuttle to Midway Beardstown .. Lockport Chicago limo O’HareI???ve spoken to hundreds of editors, employers, and project managers... Read More
My article this issue is an excerpt from a book... Read More
Have you ever had a student write to tell you... Read More
Many of the most effective low-cost marketing strategies require writing.... Read More
No user manual? Surely you jest!It may seem comical, but... Read More
In his book, "Achieving Financial Independence as a Freelance Writer,"... Read More
Style manuals are all well and good, and in fact,... Read More
Before I became a teacher, I was a sports writer.... Read More
One of the biggest problems that inexperienced writers have is... Read More
Creative Writing Tips ?When an idea comes to us for... Read More
(This excerpt is taken from my new writing workshop Writing... Read More
I'm willing to bet that quite a number of you... Read More
What Makes a Great Headline?Headlines are far more important than... Read More
Mix a martini, don't forget the olives, or pour yourself... Read More
If you want to be a writer, then you must... Read More
One day in the mid-1970's a young man stumbled into... Read More
In the current job market, many editorial workers have turned... Read More
Tips for your writing journeySo, you'd like to be a... Read More
At some point, every serious writer is forced to sit... Read More
So you've decided to crown yourself with a title that... Read More
As an editorial professional, I'm sure you're aware of the... Read More
Do you have a problem creating a focus in your... Read More
All writers should use a plan whether written or reflected.... Read More
Ever wonder why we refer to convincing an editor a... Read More
Not all writers write good grammar. That's a fact. It's... Read More
Green Bay Hummer H2 SUV rentals ..Writing papers and book reports has long been the bane... Read More
Being a great writer is no longer enough if you... Read More
When attempting to understand Creativity and Innovation, it pays to... Read More
1. Before you write anything down define not what you... Read More
No matter what your fifth-grade English teacher says, some grammar... Read More
What do you mean, you don't have a website yet?... Read More
Golden Rules For New Writers - Things you need to... Read More
There is no doubt that a staff writer enjoys advantages... Read More
What Makes a Great Headline?Headlines are far more important than... Read More
Next time you're tempted to use italics for emphasis... STOP!"Why?"... Read More
Writing technical articles is a challenge. There you sit, surrounded... Read More
1) Convince yourself you want to do something else. If... Read More
"The Magic of Layout..."???Okay... "magic" might seem a bit over... Read More
You must write a hypnotic persuasion letter to help you... Read More
Agents and publishing houses have their best interests at heart,... Read More
Our Freelance Writing Needs DefinedWe must make freelance niche types... Read More
If you become a writer for any publication, private business,... Read More
Complaint letters aren't always fun, but sometimes they need to... Read More
Sometimes there is confusion about the exact meaning of the... Read More
The hardest part of nonfiction writing is finding a subject... Read More
Some writers are just too kind.They hate to put their... Read More
Once you've plotted out your book, developed the characters and... Read More
Do you suffer from writer's block? Is there a pending... Read More
I recently set up a website to promote a new... Read More
The greatest gift you have to give to yourself and... Read More
Writing |