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.elispot-analyzers.de, http://www.elispot.cn). Dr. Velasco takes great pride in the company's commitment to user-friendliness and product excellence.
How To Cut the Clutter and Win Readers
Most of us hate housework.
How Long is a Chapter?
How long should your chapters be?
A Writers Inner Battle
There is a psychological nuisance so powerful that can deflate the drive, self-esteem, and human spirit of many aspiring Writers of any age. These Writers are faced with an obstacle that make them stop, think twice and question their right to be a part of a respected community. This even leads them to doubt their ambition of pursuing their literary or journalistic calling.
Understanding Editorial Guidelines
Editorial guidelines, also known as writer's guidelines, are the rules set forth by publishers for contributing authors. In order to have your article taken seriously you must review the guidelines prior to submission. It is also recommended that you review previous editions of the publication to get a better feel for the types of articles favored by the editor(s).
Suspense Novels Made Easy
Suspense novels are probably the easiest novels to write. Suspense novels require a simple formula, which will make your work truly suspenseful. Follow this basic recipe, and you're well on your way to building a whole library of successful suspense novels.
Tell the World About You
You have a new website, or a new business, or both ? or your site isn't getting the kind of traffic you want and need. How are you going to tell the world about what you have to offer and where to find it?
Its All About YOU!
The Hottest Word on the Web
Becoming A Successful Author: The Price!
So you want to be a successful author? You want to be up there withBrown, Archer, King, but what price are you prepared to pay? You might be lucky and your first book could be an overnight success but the chances are you'll be hacking it for years before success knocks.
A Quick Guide to ISBNs for Self-Publishers
ISBN stands for International Standard Book Number. It is a code assigned to every published book that uniquely identifies it in the marketplace. ISBNs make it easier and more efficient for libraries, booksellers and others in the publishing industry to order, distribute and catalog books.
The Author Within
Just about every marketer on the Internet claims to be the best around and would have you believe that no one else knows as much or can teach you as quickly and thoroughly as they can. It would seem that they erroneously assume that by admiring someone else's teachings they will lessen their marketability as the "great persuader" in salesmanship.
A Freelancers Journey, Part One
Today it begins.
The Psychology Of Effortless Writing
I love writing. I love the swirl and swing of words as they tangle with human emotions. ~James Michener
Memoir Writing Help, Memoir Writing Ideas
You might not need any memoir writing help, per se, as you know your past and you know quite well how to write, thank you. You might instead just need someone to inspire you, motivate you, give you a nudge--with some memoir writing ideas.
Is Now the Time for a Play about the War in Iraq?
Everone knows that comedy is mostly about timing. If you hit upon the right nerve (is a funny bone a nerve?) at the right time then, usually, you don't even have to be original or even marginally funny to win laughs. The audience laughs just at the reference (i.e. "How about Michael Jackson?") and may fall into hysterics at a gifted comic's pause.
Got an Idea? Turn it into a Novel in Thirty Days or Less!
People can't believe I did it, but I did. I wrote my first novel, The League, in about 30 days. I never spent more than two hours on any given day, unless I wrote then went back to edit. I also found and signed with a publisher in one month (see my article, Whatever It Is, Publish It Now, for details on this). Friends, family, and colleagues are fascinated when I tell them this. It's not possible, they say. Then, I enlighten them.
8 Ways to Write a Winner Book Fast!
Have you given up on getting your book out of your heart intothe hands of your readers? Don't give up. There's an easy way todo anything and a more difficult way. The easy way usuallyincludes getting helpful advice from someone that's been thereand done that. The author has written five of those ten booksthat were stuck in her heart a few years ago. Here's eight stepsthat will speed you on your way to getting your book out now:
Writing Press Releases That Get Noticed
Among the various foolproof methods used to boost traffic to your site (ezine advertising, and search engine submitting, to name a couple) one method seems to be forgotten about by many new Internet marketers. That method is writing press releases.
Screenwriting ? Five Golden Insights
Originality emerges from structure. Once you have a story idea, you can expand the idea into a story by using structure. In the initial extrapolation the new story structure will resemble the one being mirrored, but past a critical threshold, the needs of the new story will begin to dictate the structure. As you proceed (second and third drafts) the distance from the original mirror will increase significantly ? enough that the terms "novel" or "original" can be applied to the new story. Hence originality emerges from structure and mirroring.
Crime Writing Beckons
If your cash is running out fast and you have an incessant need to write, why not turn to crime?
A New Way To Self Publish
More and more good authors are turning to the Internet to self publish. There are several reasons for that. All of them are probably well known to every writer by now, so we'll not go into them here. What we'll talk about here is a new way to self publish.
|© Athifea Distribution LLC - 2013|