Laments

About three years ago, after working in journalism and finding it not my style, I took a technical writing class on a whim during my Masters studies and fell in love with it. So three years later, here I am, two years into my technical writing job with a software company. As much as I love my job, there is much that also frustrates me.

When I first came on board, the need for documentation was so great, I was busy from day one. It's been non-stop ever since, for which I'm grateful (job security!) I've accomplished a lot, released many manuals, and have a lot to be proud of. But there is one thing that remains a constant downer: no one seems to read anything I write.

Despite being told over and over that I'm doing a great job, I constantly get questions from our customers via the support team about something that is clearly outlined in the manual. It's not a "further understanding," it's a "how-to" in the first place. How do I change skins on the Web product? Read the manual. How do I add programming to a transmitter? Read the manual. How do I add an account, a customer, customization, etc.? Read the manual. It's all there. I promise you.

At a certain point, I become frustrated and think, why bother? Why am I even doing this if no one reads the manual? Is it me, or is it them? Am I just not explaining things clearly enough, or are they too lazy to look it up?

Does anyone else deal with the pressure to release documentation (especially manuals) and then find out that no one reads it? What is the point? I'm told over and over again that I'm valuable to the company, and certainly I feel I have job security, but if no one reads the freakin' manual, why even bother?

Documentation manuals aren't easy enough anymore

People want a quick answer. As suggested by your comments, these people want help or explanation on issue x or feature y; they don't want to know how to use the program from start to finish.
It's the new wave in Technical Documentation, the advent of wikis and the accessibility of the web means people can search for exactly what they want, rather than sift through an entire manual. Even the index isn't s useful as you'd think, if the user wants to know how to change skins on the web interface, the index is likely to list 'Web Interface', or even 'Skins' - but not their specific query.
People are lazier than ever, because they can afford to be. Products are becoming easier to pick up and use, and specific issues can be googled, or in your case, phone support can be contacted. As far as I'm concerned, Technical Writing is experiencing a massive change, fueled by open information.

DS Techwrite - Australian Technical Writers and LinkOne Resellers.

Dean, I couldn't agree more

Dean, I couldn't agree more about the laziness aspect, especially if you have been taught over and over that a simple call to Support will get you an answer. That's how they've been led to do it for the past 5 years or so.

I agree that the new accessibility of information is changing. I've actually implemented help into our software, so that if a user is on a specific form, they can press F1, and the CHM file will pop up, showing them information for that screen. This is pretty exciting (to me, at least), but I believe it will take a long while for people to break their old habits and start new ones.

Context sensitive help is

Context sensitive help is definitely the way to go, although it is still such an effort to get people to use it.
I sometimes think web forums have got it right, the anonymity allows people to be harsher than they possibly would be and it actually helps. Try going onto a popular forum and post a new thread asking for help about a subject that's already been covered, chances are the first reply will flame you for not using the search button. It's the kind of mistake you only make once.
Maybe we just need to be more aggressive =)

DS Techwrite - Australian Technical Writers and LinkOne Resellers.

I don't care if no one reads my docs

I don't care if no one reads the documentation I create. The docs are there if the user needs them.

If I help one tired, frustrated, angry, confused user -- just one over the lifetime of the document -- then I have done my job well.

If no one ever reads the user guides I produce, that does not diminish the fact that I poured my blood, sweat, and tears into creating them. The guides still exist and I wrote them.

If no one ever reads the user guide I create, so be it. Life rolls on.

For the one person who reads the manual

A long-time writer, Tom, used to say that we're writing for the one person in that company who will read the manual. Most of the time, users (including yours truly) will stand on a chair to ask someone in the next cube about a problem with a product. Not only is it easier, but the answer is more likely to be fit because that other person knows, or can easily discover, my context. Remember, my job is not to learn Framemaker; it's to write a document. So, my asking my colleague helps me learn enough to get my primary job done. My colleague has probably read the manual, used Google to track down a bug, and maybe even spoken to the product's tech support team; my colleague did that willingly because my colleague is a nerd. (I've been on both sides of the cube wall.)

So, IMO, it's OK to target the resident smart person at the customer's site rather than trying to find way to trick end users into reading our fine manuals.

Well, I can't say that many

Well, I can't say that many of my colleagues have read the manual, but that's because they've been around a lot longer than me, and know more than me. I can think of one or two new folks who have read it, and found it helpful.

For what it's worth, I think Tom is right - perhaps not the one person in the company, but rather, the one customer who reads the manual and finds it helpful. Perhaps that is what makes my job worth the time and effort I put into it.

Re: Laments

I loved this post. It does get to the heart of something that twists our insides -- the praise we receive about how valuable our contribution is, while at the same time knowing that few actually use what we contribute.

You might try delivering more than just a manual. Maybe your users would like a list of top ten FAQs or videos, or something else.

But even if you just give them a manual that has a pretty cover and terrible content, it will act as a pacifying placebo in the same way your car manual in your glovebox functions. Sure I like to have that manual in there, but I've only glanced at mine when I'm totally bored. I rarely use it, but if I were to lose it, it would pain me greatly.

By the way, I added a link to this post on WriterRiver.com, a social media news site similar to Digg.com but for technical communicators. You can view the post here.

Tom, thanks for the good

Tom, thanks for the good ideas. I agree with you... perhaps it is time to deliver more than just a manual. It is just hard to pour yourself into a 400+ page manual and have no one read it, or as the same questions over and over again, while my response each time is "did you read the manual?" I like the top 10 FAQs idea. We have a Web site and it would certain add to it.

Thanks for the link on WriterRiver.com. :)

Something new

I understand your frustration. I wrote mortgage loan and engine analyzer software manuals for years. I found that people are not crazy about reading a monolithic book. We, as writers, see the value of the book, but we are not necessarily our audience. Not sure how your manuals are delivered but maybe it's time to try something new. If you're not already doing so, think about online FAQs with short answers and links to the long answers in your manual. Be creative...try something new. Hopefully, the users will thank you and it may save your sanity!

persevere

As long as the support team continue to provide your users with a more convenient option of bypassing the manual altogether by answering questions directly over the phone, then I expect your disappointment to continue.

However, if everyone in the support team were to persistenly refer users to the manual instead of repeating the same answers over and over then users will gradually cotton on that actually the manual is the best first point of reference. It's all about educating the users to help themselves and stop being lazy which the support should embrace as a goal because that's less strain on their resources...

Only then can the real test of how good your documentation actually is can take place...

Best

LW

thanks

LW thanks, and I completely agree. It's ironic because the Support Manager always complains about having too much work to do, and wants the manuals to unload some of the more basic support questions, but he and his team continually just refer to "the technical writer" for all their questions, 99% of which can be found in the manual.

I've considered bringing this up to my boss and having him in turn encourage the Support Manager to tell the customers to refer to the manual.

Laments

Same as it ever was, alas. Seems manual-readers still enjoy minority status; perhaps the same is true of readers in general. Technical or not, writing is a thankless gig.