Tech-writers: A Necessary Evil

Navigation: Main page » Copywriting

 Print this page Submit articleComment article

Author: Glenn Murray

Article source: http://www.goarticles.com/. Used with author's permission.

New to tech-writing, or thinking about starting? The key to success is recognising that tech-writers are a necessary evil.

Tech-writers are necessary because someone has to write the user doco. The programmers and managers sure as hell don't want to. This is actually part of the reason that you're evil, too. In my experience, most programmers and managers think that they could write the manuals if they wanted to… they just don't want to. They might not write all "flowery" like the tech-writers, but what they write is correct.

Unfortunately, that's quite often all that's important to programmers and managers.

There is a feeling within the software environment that accuracy = quality. Audience analysis, doco readability, consistency, usability, active and passive voice, commas in a list of three or more items… All of these things are relatively unimportant to everyone but the tech-writer. Oh… and the user.

In a world where accuracy is all important, a lot goes over the head of the dummy. I don't know if it's intellectual snobbery, but programmers and managers seem to think that if they understand it, so should the user. It doesn't matter whether or not they do… they SHOULD! Stupid users! Maybe it's the geek's ultimate revenge…

Your document can be 100% accurate, but if the audience can't read it, you've wasted your time.

So why doesn't anyone acknowledge this? They do! That's the weird part. In theory, everyone agrees with you, it's just in practice that you find yourself out in the cold. I don't know why this happens. Maybe it's because most of these guys have never done tech-writing.

So tech-writers spend too long worrying about unimportant things. And they bother programmers and managers with unimportant things. But they're necessary things. Otherwise why would you be employed. Maybe the absence of simple logic short circuits their brains. Who knows?

What we can get out of this is that there's a feeling that tech-writers waste time, and as a result, they're pretty much at the bottom of the heap in the software world. I think a good analogy is the way some rich see the poor. Dirty little creatures… if only we could do without them…

But there is an up-side. I don't want you thinking it's all bad.

Being at the bottom of the heap has its advantages. You can go unnoticed for years if you want. If you haven't seen the movie, Office Space, you should hire it. There's a little ferrety bloke in that who was "let go" years ago. Problem is, no one ever told him, and because of a glitch in payroll he still got paid. No one ever noticed.

Being a tech-writer's a bit like that.

When I was managing doco teams, my favourite saying was "All we have to do is manage their expectations and our commitments". Because programmers and managers resign themselves to the fact that they don't know what's going on in the doco team, there's sometimes a temptation to slacken off. Don't give in to this temptation!!! If you ever get caught, doing it, it'll be like the boy who cried wolf - they'll never believe your estimates again!

The other risk is that you'll lose your sense of urgency. And that's a big part of what makes a good worker. You should be very strict about managing your commitments. This requires discipline, because sometimes it seems you're the only one that cares, but you have to do it.

One thing you should be aware of though, is that your average tech-writer in software spends only about 50% of his or her time writing. The rest of your time is spent planning, problem solving, fixing your computer, researching, interviewing the programmers, writing work pracs…

I always found it was a good balance, though.

It was when I started managing teams that the bottom really fell out. Then the percentage dropped to about 10-20%. There were times when I'd go months without writing any help at all. That can be very frustrating, especially if you don't particularly like managing.

Now managing tech-writers in software is an interesting thing. As with most technology management positions, you kinda fall into it, because you're the most senior/experienced person in the company. Unfortunately, that doesn't qualify you to be a manager. Software companies are renowned for dumping people into management roles without any real training or support.

I don't really have any advice for you here. If it's gonna happen, it'll happen. Just be aware of it, and know that if you fall into a management role, it's gonna be difficult. (That's not to say that it can't be rewarding though…)

The ironic thing is that the most difficult aspect of it is that your staff are screaming at you to change the system. "The programmers don't answer our questions!" "None of my work has been reviewed for the last 2 months!" "The project manager just told me to forget about quality!"

Unfortunately, the inexperienced tech-writer is often naïve enough to think they can change the system. Once you become a manager, you know you can't. Hold on a minute… Maybe apathy is what qualifies you to be a manager… Hmmmm.

In any case, my advice is not to push too hard. You'll make life hard for your manager, and give yourself a bad reputation. Recognise you're a necessary evil, and work within those constraints.

Tech-writing can be a lot of fun. And don't let anyone tell you it's not creative. Trying to think of a way to describe what goes in the Name field without just saying "Enter the name" is a real mind-boggler!

The Boom Fraud -- Mortgage Market Fraud On The Rise
While mortgage experts caution against the impending housing bubble, the housing market continues to boom. Like all hot markets, the scammers can't staw away wh...

Making Dangerous Dating Assumptions
When men and women are dating, they always seem to make assumptions about what is going on in the other person's mind. Assuming things like this will lead to no...

Lesson 2 - The Commodity Of Kings!
In this second lesson from the 10 lesson financial fitness system, we focus on the contemporary power of wealth building, specialized information.

More Cheap Tricks for Promoting Your Business
In a recent article, I shared five of my top 10 favorite tricks for promoting your business without spending much (or any) money. Several readers wrote and said...

How to Get Customers for Free
People spend a lot of money getting new customers in one by one. Using search engines to send people to you can generate a constant stream of qualified customer...

6 Things to Increase Your Affiliate Income
6 important steps to increasing your affiliate income.

Reach Your Goals - Creative Multi-Tasking
The "Reach Your Goals" series started out as a tip sheet that quickly grew out of control - what started out as a small collection of goal and success tips even...

Supporting Local Flavors
Americans are rediscovering the benefits to supporting their local growers.

How To Attract More Leads
You want referrals. And you know many others who also want them. Have you given them any? If not, why should you expect any from them?

The Walmart Cult
The Cult: Becoming a part of the Cult, consists of being recruited a member of the cult, as a person that can be relied on to assume responsibilities and accom...

Are You Getting All Your Vitamins?
Far from the Flintstones shapes many of us chewed as kids, adult vitamins provide nutrients needed by a full-grown body

Simple Technique for Isolating Objections
To isolate any objection quickly you can use this effective and powerful sentence - "Aside from "that" is there anything else?"

5 Top Exercise Tips to Burn Fat While You Sleep!
5 killer exercise tips that will crank up your metabolic rate in no time to turn your body into a 24 hr fat-frying furnace! Burn fat when you're sleeping with t...

Feeling Grouchy? Heres What to Do
I woke up this morning feeling sour. No. That's an understatement. My throat was tight. My head was foggy. I felt like wearing a sandwich board that read, "Cra...

Natural Tonics for Health and Wellness
Natural tonics have been around for as long as people have had headaches. Find out more about this old time method of improving your health.

Different Detox-cleansing Regimes
A detoxification treatment is designed to help the body eliminate stored toxins and strengthen the organs involved in this process. Read more about the differe...

How To Walk On The Path Of Peace (Part 3)
Can we really leave it up to the "powers that be" to sort out peace on earth? I think not. We have to realize that we are the "powers that be" that make the dif...

Ben Wa Balls - How To Use Ben Wa Balls And Their Benefits
Ben Wa Balls have been around since 500 AD and still have widespread use today among women. Learn why women and men love Ben Wa Balls and the amazing benefits t...

When Panic Attacks Writers
If you write for a living and have worked with deadlines for a few years, you probably know what I mean...when suddenly everything seems impossible...and you st...

How To Alleviate Your Acne Problem
Knowing the facts that debunk the myths and misconceptions about acne may help you alleviate your acne problem.

Property Investment Just Got Exciting
Lower crime than where you are right now, lower property prices, hundreds of miles of beaches, stable warm weather, and a property market that makes investment ...

Top Ten Reason to Publish an Ezine AND a Blog
Blogs are the hottest thing going these days when it comes to marketing on the Internet. A blog is a way of delivering your messages and article to clients. The...

Personal Motivation: Without Struggle There Is No Progress
Overcoming life's daily challenges is something that everyone faces. Successful people appear to have some magical wands that wisks away life's troubles. Possi...

How Writing Radio Can Help You Become a Better Writer
Knowing how to write, and write well, is a skill that will come in handy in all sorts of situations. And if you combine good writing skills with the persuasiv...