I should probably start by mentioning that I’ve fought this battle for long years … and was utterly defeated. About 7 or 8 years ago, high-tech companies, in a money crunch and driven by that bottom line that seems to be the only thing that matters anymore, began to eliminate technical writers. Entire departments were dismantled and eliminated. Jobs disappeared and what remained paid so badly it was insulting.
A decision had been made at the corporate level: YOU don’t need documentation. No matter how complicated or expensive the equipment or software you purchase may be, don’t need documentation. Companies provide the minimum the law requires or they can get away with. Quality is no object nor usability. Information is limited to basic stuff like how to install a battery and if you are lucky, where the compartment is.
I was a technical writer for about 75% of my career, the rest being divided between journalism, editing, promotions and advertising. But mostly, I wrote documentation and I though my work mattered. Probably naive, but I believe that if I documented a system, it should be well written, clear, organized, and useful., When a user needed to find something, it would be in the book and in the online help. It would be easy to find. I carefully avoided using mysterious search parameters that could be deduced via a psychic link to my brain. If you knew what you wanted, I made it easy for you to find it.
I was proud of my work. I still believe the fundamental goal of documentation is to make complicated things simple. Not necessarily easy because sometimes, the product was not easy to use, but that didn’t mean that it had to be hard to understand. My documentation was good for another reason: I used the product and tested what I wrote to make sure it was true. This testing makes the difference between a pile useless gibberish and a manual.
Thus, when you get something that appears to be documentation, stop and read it. Appearances are deceiving. Most “manuals” are generated, not written, and never checked for accuracy or usability. Such “manuals” are as likely to increase your confusion as provide illumination.
I bought a PEN EP3 camera from Olympus. Seven months and hundreds of photographs later, it remains one of the mysteries of my world. It takes wonderful pictures, and it has hundreds of functions. I haven’t the slightest idea how to find most functions and have no idea what to do with them if I could find them.
I grew up in a pre-digital world. I know F-stop, depth-of-field, shutter speed, aperture and focus, film speed and composition. I have a good eye. I’m no genius, but my pictures are pretty and I enjoy taking them.
New digital cameras have a vast and overwhelming array of functions, most of which you or I will never use or need. I believe they are there entirely to impress us with the super high tech-ness of the equipment. I doubt that even the designers — especially the designers — expects us to actually use them. Which is good, because I don’t know what they are supposed to do anyhow or why I would need them. Ansel Adams didn’t need them. Neither did Edward Weston. Neither do I. But, the more you pay for a camera, the more of these obscure functions you get and I figure that the least they owe me is an explanation of what these setting do and how to find them.
I’m not sure whether to curse or say thank you. Maybe if Olympus provided a manual that explained these options, I’d be grateful, but that is not happening.
This is true of cameras, but the lack of documentation on your computer is actually worse … much worse because most of us depend on our computers. We need them to work and we need to have some control over the environment in which we work. Configuration of our computers to suit our needs is not a minor detail: it’s the difference between having a tool that does what you need and one which is a burden … an enemy with which you do daily battle.
I spent all last night — until dawn — trying to figure out how to turn off the touchscreen functions of my monitor. Before Mac users jump in and point out that it’s because Windows doesn’t work, that’s irrelevant and untrue. Windows works fine. It’s just that the company doesn’t provide any written documentation. There is embedded information in the operating system, but much of it isn’t logically arranged. It’s rather like looking for your car keys after you’ve dropped them someplace you don’t normally put them. You know they’re in the house, but where? It could be years before you find them..
On a new computer, you typically get an “introductory” video and that’s pretty much it. I watched it. It showed me in exquisite detail how to do what I already knew how to do.
Operating systems are designed to be used the way the system’s developers expect you to use it. If you prefer a different setup, trouble starts. The only way to figure out how to do something differently is to keep querying the system and hope you’ll stumble on the right key word — the word that will bring up the information you need. What is most frustrating is that you are sure it IS there, but whether or not you will ever find it is a different issue.
If you are sufficiently persistent and a bit lucky, you will eventually find a mystery menu after which you fix your problem in a few seconds.
Last night, I searched, searched again and again. It didn’t call Dell because I knew the support person wouldn’t know the answer either. They pretty much never do.
So I tried one word combination after another, recombining them in the hope that it would lead to a menu buried in the system. There had to be a way to deactivate touch input.
Around 5 in the morning, I found it. It took me less than 30 seconds to eliminate the problem that had been driving me nuts since I got the computer. Now, it’s a monitor. A great, high-definition, 23-inch monitor that’s a joy to work on and makes photo editing a pleasure. No more configuration by crawling insect. I am mistress of my virtual world at last!
A technical writers earns less than an entry-level developer. I understand the guys in India who provide telephone tech support work cheap, but I bet a tech writer would cost less than a network of telephone support no matter how cheaply they work.
Assuming you are under warranty and you can get through the voice mail maze … and further assuming you get someone who understands the problem and don’t get blown off because software is not part of your warranty (Note: If someone can tell me how, without using software, you can determine if you have a hardware problem, I’d like to hear it) … Round and around you go.
It doesn’t have to be this way.
Would it blow the budget to hire a competent technical writer to embed online help that will live on even after the warranty period is over? Wouldn’t it be nice to help users avoid needless aggravation and not wind up with angry, frustrated, exhausted, and homicidal customers whose problems remain unsolved?
Granting that many home users have a limited understanding of how their computers work and for them, it wouldn’t much matter what documentation you supply. Most problems result from insufficient understanding of a product or process. If you are talking about a novice user, perhaps more information wouldn’t help. But …
I’m not inexperienced and I still can’t find essential information I need to configure my monitor. Wouldn’t it be reasonable to expect a menu on the control panel that I could use to configure the monitor’s capabilities, not merely its resolution but any other functions it may have. Functions not available on a particular model could be grayed out. How about that?
There is nothing wrong with my computer that better organized and easier to find information would not solve..
Every issue I’ve had or the last 5 or 6 years was ultimately fixed with a few clicks of the mouse. The problem was never something broken. It was always lack of documentation.
That pisses me off. Because tech writers — even highly experienced ones — work pretty cheap. Users do need documentation, and not just for software and computers. We need documents that let us use our cameras and telephones and DVD players and all those other pricey little devices that we own and often, don’t know how to use. Online FAQs are insufficient.
This is an old battle I’ve already lost. I know it’s hopeless. I find it infuriating that I can barely figure out my telephone without customer support, so rather than spend time on the phone with customer service, I don’t use anything I can’t easily configure.
I had to buy a separate book on how to use Photoshop and another for my first camera. I was able to get some help from a fellow user of my new camera, but that only goes so far. For my PEN P3 camera, there IS no customer support nor any after market book. I depend, as Blanche DuBois said, “… on the kindness of strangers.”.
My camera will remain a mystery until someone writes a “Dummies” book for it. Hopefully I’ll still own the it when the book finally gets published.
It’s not fair. The reason they get away with it is because we let them. Think about it.
So how did I finally figure it out? The “monitor” menu should have been a gateway, but was useless. The only thing you can the “Monitor” menu lets you do is lower your screen’s resolution. That’s useless.
Finally, I typed: Touchscreen.
Up came something that I hadn’t considered. Flicks. Now, for me? That means the movies. Having never used it, I had no idea it had anything to do with the monitor or its touchscreen technology. Once I got to “Flicks,”, I started opening menus and voilà, there were two check boxes allowing me to toggle an option:
- Enable finger as pointing device.
- Do not allow finger as pointing device.
I un-checked the first one by checking the second. I clicked “Apply.” As the sun rose in the east, my problem was solved and I went to bed, to sleep, perchance to dream … of murder, destruction and vengeance.