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.
family-safe home cleaners Bannockburn ...Names are important. Names give clues about us, where we... Read More
Weather posting a page to your Website, writing a letter... Read More
Remember the days when we wrote with pen and paper?... Read More
Riding on the fumes of potential, you take pen to... Read More
PASSED, PASTPassed is the past tense of pass. Past means... Read More
Screenwriting is a competitive trade. To distinguish yourself as a... Read More
In reviewing and browsing web sites over the years, I... Read More
What possibly could I have to write about? I never... Read More
What am I supposed to give Anthony as a wedding... Read More
Rudolph Flesch, a pioneering advocate of readability, put great stock... Read More
Beyond three and four act story structure, lies the Hero's... Read More
Last week I was having a quick browse on eBay... Read More
How to Come Up with Fresh Story Ideas When Your... Read More
The Internet has truly revolutionized the careers of writers worldwide.... Read More
Suspense novels are probably the easiest novels to write. Suspense... Read More
Do you love someone very deeply? A spouse, son, daughter,... Read More
I'm willing to bet that quite a number of you... Read More
What a wonderful resource the Internet is!Students find information to... Read More
Ever wonder why we refer to convincing an editor a... Read More
Is there a book inside of you? Yes? Then why... Read More
Often, time is an enemy of writers. Sales seem slow... Read More
Our Freelance Writing Needs DefinedWe must make freelance niche types... Read More
During my 25-year career in a variety of professional positions... Read More
Don't they drive you nuts?You can visit all the rules... Read More
Paulo Coelho was born on August 24th 1947 in Rio... Read More
last minute cleaning help Arlington Heights ...The Hottest Word on the WebDid you know marketing people... Read More
In the ten years that I've taught people how to... Read More
"If you want to change your life," Harry Beckwith wrote... Read More
Have you ever wondered why certain writers are able to... Read More
It occurred to me one day that I needed something... Read More
Summer's here and the time is write for dancing in... Read More
Boost Brain Power Through WritingHave you ever noticed what happens... Read More
A writer writes. Bet you've heard that one... Read More
Finding the time to write a novel is one of... Read More
There's nothing that kills a scene like hackneyed dialogue. Just... Read More
Just about everyone is familiar with this beginning: "In the... Read More
I've been in the communications business a long time?over 25... Read More
Everybody knows writing a story is not easy. Like the... Read More
Riding on the fumes of potential, you take pen to... Read More
When we write stories, with the purpose of sharing them... Read More
You can make a lot of money by writing and... Read More
Questions and answers on writing life experiences for ourselves and... Read More
It turns out that "tips and templates on how to... Read More
Okay. So I'm not David Letterman. But I doubt if... Read More
Virgil, the great Roman poet, wrote "Practice and thought might... Read More
Since the headline is the first contact your readers have... Read More
Language Training - A key to Global CommunicationLanguage Training is... Read More
Almost everyone could profit from enhancing their writing skills. From... Read More
What am I supposed to give Anthony as a wedding... Read More
The works you've written are numerous, ranging from short stories... Read More
Writing |