Tech-writers: A Necessary Evil
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! About The Author * Glenn Murray is an SEO copywriter and Article Submission Specialist. He is a director of PublishHub and also of copywriting studio Divine Write. He can be contacted on Sydney +612 4334 6222 or at glenn@divinewrite.com. Visit http://www.divinewrite.com or http://www.publishhub.com for further details, more FREE articles, or to purchase his e-book, 'SEO Secrets'.
Related News
|
 |
|
|
RELATED ARTICLES
11 Things You MUST Know Before Hiring a Copywriter!
If you're considering hiring copywriting help for your next brochure, Web site, or marketing project. Congratulations! You should get great results if you hire a pro to do it right.
Direct Mail Sales Letters Flow Better With Subheads
A subscriber to my newsletter asks: "Got any good pointers on writing great sub-heads?" Yes, I do. Here they are.
Business Writing: When Not To Be Professional
It's time to write your next ad or brochure. Maybe some web content. You've done all your research, and you're staring at a blank computer screen. You want to look good in print. You want to put your "best foot forward." And, of course, you want to make a barrel full of money.
Four Simple Steps to Improve Your Sales Copy
You know what it's like, you're reading the sales material about a product you're considering buying, but, as you read, all these questions seem to pop into your mind, but there's no-one there to answer them, so you shelve your plans to purchase.
3 Copywriting Tips - How To Edit For Mass Appeal!
Web copy that's intended to sell or generate leads needs to quickly reach out and grab attention and build rapport with a target audience. You can connect with your audience more effectively if you understand something about how people process information, and how they think.
Better Copy: The Interview is the Key
Most of us spend our days persuading others to buy our service, product or idea. Here is how to create powerful marketing copy to make your job easier: INTERVIEW YOURSELF.
Designing for a Non-English Audience
Having worked as a digital publishing specialist at a large corporation at my previous job, I did not think being in charge of foreign language typesetting would be too difficult. After all, the layout and the images are already prepared and I only need to flow in the text - how hard could that be? I was sure that a simple Copy and Paste, or text importation, would do everything. This was my point of view when I initially began managing DTP projects in different languages.
How You Can Proofread Your Own Work
Putting out a high quality product is a given these days. With all the competition out there, you have to look great in every aspect. So proofreading all copy is extremely important and here are some tips to help you to proofread your own work after you've finished editing it:
A Quick Free n Easy Content Writing Course
I do not pretend that a one-stop shop solution to content writing exists, but my experience has taught me, that working toward a 100% effective writing formula isn't a complete waste of time.
Prevent Procrastination With Positive Pressure
My wife and I recently bought a house.
Copywriting 101: Exclamation Point, Friend or Foe?
My name is Ann and I'm a grammar geek. There, it's out and I'm relieved. Does this mean my writing is perfect and consistently conforms to grammar rules? Heck, no. It does mean that I spend hours perseverating about serial commas, dangling participles, and feeling guilty if I end a sentence with a preposition. I worry endlessly about what I call the PowerPointification of America (i.e., the trend toward writing short chunks of information in bullet points - which, incidentally, is what sells). I can't bring myself to use abbreviations in e-mail or instant messages. I don't use emoticons. I can't help it. For better or worse, I'm a word nerd.
Working on the Internet: Role of Proofreading and Copy editing OnLine
When one is in a creative state, rarely can one also be in a detail state. Thus, mistakes in correct grammar, spelling and continuity of all details, may happen. Also, proofreading our own work can be very difficult, for all of us. This is because the same mental processes that went into composition are the ones we use to correct our work. Hence, so many websites are launched every year but so many of them fail to work perfectly as these sites have not been tested with a Proofreader's fresh eyes and impartial knowledge of English.
Online Promotion Beats Traditional Ten-One
While traditional marketing can work for the book author or publisher, the return is dim for the huge effort it takes. You must promote 90% of the time to even get a milligram of attention. While you may have a success or two, most of your efforts will bring poor book sales. Ask yourself right now, what is working for me? What is not?
Its Not What You Say But How You Say It
Copy is all about words. Or is it?
Calls-To-Action: Making Them Fit Makes All the Difference
It was going so well, so what happened? Many copywriters get off to a wonderful start: The headline is compelling, the body copy is benefit-filled, but then comes the call-to-action and the whole thing falls apart. Why? It could be a dozen different reasons, but one of the most common I've seen is that the call-to-action doesn't fit the target audience.
Four Things Every Web Site Headline Must Do
As you know, I'm constantly making the point that the text on web sites is not given enough attention. Which is unfortunate, because the headlines on site pages make huge demands on the skills of any writer.
How You Can Find Freelance Children?s Writing Positions That Will Last
Freelance children's writing positions are always advertised. Rather, the schooling to learn how to write for these jobs is advertised. But, there is often a large lack of employment vacancies actually available. Many of these companies offering to train individuals in these positions claim that there are quite a few companies offering employment or that will publish their work. In fact, it is up to the individual to find these positions themselves, and as it turns out, it is very difficult to get published. So, when the opportunity for freelance children's writing positions becomes available, it is essential that good care be taken to ensure that the relationship lasts.
Professional Writing: Six Great Reasons to Hire a Writer
Most people can write. Some can even write well. But only a few individuals can write as quickly and persuasively as a professional writer. Effective communication requires a well-crafted message that is interesting to your audience. Anything less is a waste of your time and money.
Top 3 Rules for Writing Effective Copy
One thing all successful Internet marketers have in common is that they're good copywriters. If you want to have a profitable online business, you need to know how to write a copy that motivates people to buy your product... a copy that sells!
Freelance Copywriters on the Internet: How to Tell the Difference Between Heaven-sent and Hack
If you're hunting for a good freelance copywriter and have never done it before, or if you have but find yourself needing another for the first time in a while, I don't envy you. This "brave new" e-world has turned your once straightforward search of a neatly stacked file of brochures and introductory letters into a bothersome wade through a mucky world of half-baked online listings and search results which only seem to list those freelance copywriters who are experts in SEO, or at least know what the heck it means (search engine optimization).
|