New to tech-writing, or puzzling over beginning? The key to success is recognising that tech-writers are a necessary evil.
Tech-writers are necessary because somebody has to jot down the user doco. The programmers and managers sure as hell don't want to. This is often truly half of the rationale that you're evil, too. In my expertise, most programmers and managers suppose that they might write the manuals if they wanted to... they merely do not wish to. They might not write all "flowery" like the tech-writers, however what they write is correct.
Unfortunately, that is quite often all that's vital to programmers and managers.
[ advertisement ]
There is a sense inside the software setting that accuracy = quality. Audience analysis, doco readability, consistency, usability, active and passive voice, commas during a list of three or more items... All of this stuff are relatively unimportant to everybody but the tech-writer. Oh... and the user.
During a world where accuracy is all necessary, a lot goes over the top of the dummy. I don't know if it's intellectual snobbery, however programmers and managers seem to suppose that if they perceive it, therefore ought to the user. It does not matter whether or not they do... they SHOULD! Stupid users! Perhaps it's the geek's ultimate revenge...
Your document will be a hundred% correct, but if the audience can't scan it, you have wasted your time.
So why doesn't anyone acknowledge this? They do! That is the weird part. In theory, everybody agrees with you, it's just in apply that you find yourself out within the cold. I do not grasp why this happens. Perhaps it's because most of these guys have never done tech-writing.
Thus tech-writers spend too long worrying regarding unimportant things. And that they trouble programmers and managers with unimportant things. However they are necessary things. Otherwise why would you be employed. Perhaps the absence of simple logic short circuits their brains. Who is aware of?
What we tend to can get out of this is often that there is a feeling that tech-writers waste time, and therefore, they're just about at the bottom of the heap in the software world. I think a good analogy is that the approach some made see the poor. Dirty little creatures... if only we could do while not them...
But there is an up-side. I don't need 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 must rent it. There's a little ferrety bloke in that who was "let go" years ago. Problem is, nobody ever told him, and as a result of of a glitch in payroll he still got paid. Nobody ever noticed.
Being a tech-writer's a bit like that.
When I was managing doco teams, my favorite saying was "All we have to try and do is manage their expectations and our commitments". As a result of programmers and managers resign themselves to the very fact that they do not apprehend what's happening in the doco team, there is generally a temptation to slacken off. Don't give in to the current temptation!!! If you ever get caught, doing it, it's going to be like the boy who cried wolf - they will never believe your estimates again!
The opposite risk is that you'll lose your sense of urgency. And that's a big half of what makes a good worker. You must be terribly strict regarding managing your commitments. This needs discipline, because generally it appears you are the sole one that cares, however you have to do it.
One factor you must remember of though, is that your average tech-writer in software spends solely about fifty% of their time writing. The rest of it slow is spent coming up with, problem solving, fixing your pc, researching, interviewing the programmers, writing work pracs...
I perpetually found it was a good balance, though.
It had been after I started managing teams that the underside extremely fell out. Then the proportion dropped to concerning ten-20%. There have been times once I'd go months without writing any facilitate at all. That can be very frustrating, particularly if you do not particularly like managing.
Now managing tech-writers in software is an fascinating thing. Like most technology management positions, you kinda fall into it, as a result of you're the foremost senior/experienced person within the company. Unfortunately, that does not qualify you to be a manager. Software companies are renowned for dumping folks into management roles while not any real training or support.
I don't extremely have any recommendation for you here. If it's gonna happen, it's going to happen. Simply be aware of it, and know that if you fall into a management role, it's gonna be difficult. (That is not to mention that it can't be rewarding though...)
The ironic factor is that the most difficult side of it is that your workers 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 two months!" "The project manager simply told me to forget concerning quality!"
Unfortunately, the inexperienced tech-author is usually na?ve enough to assume they will change the system. Once you become a manager, you recognize you'll be able to't. Hold on a minute... Maybe apathy is what qualifies you to be a manager... Hmmmm.
After all, my recommendation is not to push too hard. You'll build life hard for your manager, and offer yourself a dangerous reputation. Recognise you're a necessary evil, and work among those constraints.
Tech-writing can be a ton of fun. And don't let anyone tell you it is not creative. Making an attempt to think of a method to explain what goes in the Name field while not simply saying "Enter the name" may be a real mind-boggler!
Author Resource:-
Smith Richardson has been writing articles online for nearly 2 years now. Not only does this author specialize in Personal Tech (Computers and Technology), you can also check out his latest website about:
