| ďťż |
|
|
By Glenn Murray [ 27/07/2005 ] Publishing Free Articles Zone articles is subject to our Publisher's Terms Of Service |
|
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 a website copywriter, SEO copywriter, and article submission and article PR specialist. He is a director of article PR company Article PR 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.ArticlePR.com for further details, more FREE articles, or to download his FREE SEO e-book.
Although not essential, I would really appreciate it if you could notify me when you make the change as well.
Article Source: http://www.Free-Articles-Zone.com