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.
Lincoln Stretch rentals Alsip ..Chances are, you'll be busy over the next several weeks.... Read More
First, let's tackle the question that is uppermost in many... Read More
Our Image-Driven SocietyWe live in a new image-driven society. It... Read More
In most aspects of business, we will be expected to... Read More
Want to write your book? But, need a blueprint on... Read More
FIVE MINUTES ... Is All You Need ........to phone a... Read More
Have you ever wondered how you can adapt your screenplay... Read More
In his book, "Achieving Financial Independence as a Freelance Writer,"... Read More
It's easy to feel overwhelmed by marketing. First, there's so... Read More
Dream that your book can be a number one best... Read More
"You should write a book." For years, I had been... Read More
The first five pages of a novel are critical.Editors make... Read More
1. Use Logic: Check for External PressuresAre you under physical... Read More
As in all endeavors, toil is necessary to succeed and... Read More
So you've got your plot outlined, a title lined up... Read More
Most books aren't rejected because the stories are "bad." They're... Read More
A few months ago, I wrote a guide entitled: 101... Read More
Are you ready to abandon your short stories? Before you... Read More
How long should your chapters be?I can't resist... I have... Read More
The hardest part of nonfiction writing is finding a subject... Read More
On the first day of a bright and shiny new... Read More
No matter what you are writing, the first priority is... Read More
ESSAY 3Writing an autobiography involves a matching up of a... Read More
As a professional copywriter, not only do I do a... Read More
It would be very selfless or noble of me to... Read More
Western Springs shuttle limo ..Some writers are just too kind.They hate to put their... Read More
The biggest mistake authors make when trying to get free... Read More
People can't believe I did it, but I did. I... Read More
Have you heard the term 'ghostwriter' and wondered what they... Read More
Creative Writing Tips ?When an idea comes to us for... Read More
In a crowded market, clients will be seeking personality as... Read More
What is Sense of Place? It's the image of a... Read More
Arrogance has a bad rap. We think of arrogant people... Read More
A poet isn't born; you must work at crafting your... Read More
As in all endeavors, toil is necessary to succeed and... Read More
1. Write it fast, fix it later.2. Commit to writing... Read More
It turns out that "tips and templates on how to... Read More
Without denigrating the work and contribution of Syd Field to... Read More
How to get a lot of traffic to your website... Read More
In the current job market, many editorial workers have turned... Read More
9 out of 10 professionals and small business owners have... Read More
What is this annoying, insidious angst that permeates my psyche?... Read More
One morning, you open your inbox and find several e-mails... Read More
These 8 tips on using characters in your stories will... Read More
You can turn your $200 fee to write a press... Read More
Are you ready to abandon your short stories? Before you... Read More
Real Estate has "Location, location, location," and writing has "Clips,... Read More
Readers often send me interesting and exciting e-mails about the... Read More
Beyond three and four act story structure, lies the Hero's... Read More
A UK based freelance proofreader should be able to provide... Read More
Writing |