Why Aren’t All Technical Writers Technical?
This is a question that has been posed to me more than once by coworkers of various backgrounds. Many of whom mistakenly believe that they need to “talk down” to a technical writer because, in their experience, most writers could never get their heads around the technical details presented in the functional or design specification.
Why do they believe this?
Well, for some these folks, they are simply looking for the impossible. Even though many technical writers have science and/or engineering backgrounds, no writer can be a master of everything. There are areas of computer science and mechanical and electrical engineering that I will probably never understand, forget about master. Sure, I know what “polymorphism” means, but there are quite a few things that I need to dust off an old reference book for or simply learn on the job. Many times all that is required to write clear and accurate technical documentation is a working understanding of these concepts and methodologies, not a Ph.D.
However, other coworkers who have asked this question do have a valid point. It is a common sign of the times to run into technical writers who are excellent grammarians and masters of the English language (or other languages), but who would be hard pressed if asked to actually install the software (or hardware) they write the installation guide for. The dot com boom did not help the situation at all. Even having a degree was optional in some places during the boom time, and anyone with an English or Journalism degree could grab a high salary.
Even though many people profited from the “gravy days” (including myself!), it did leave many people with an incredibly skewed perspective, or flat out bad impression, on what a technical writer is actually trained to do. I’ve had more than one development manager or software architect immediately give me the cold shoulder when I tried to provide feedback on their code, or talk to me like I was a newborn babe because the writer before me couldn’t tell the difference between a drive array and an Oreo cookie. I’ve also had many of these people stare in fascination because I used GNU Emacs or knew what a “subnet mask” was.
How can we improve our image?
For every new technical writer breaking out into the vast unknown of the computer industry, I recommend one personal guideline that can’t be stressed enough…be technical. It sounds rather foolish to tell a technical writer to, well, be technical! However, learning or refreshing your working knowledge on subjects related to your industry is not only helpful for your job, but also helps the technical writer community as a whole. As my parents constantly reminded me, “You never stop learning”. In order to improve our image, we have to gain respect, and we’ll never garner any respect from our technical comrades if we continue to put forth the image that all a tech writer can do is tell them where to put a period.
And dammit people, be adventurous! Install the freaking software, look at the source code, pay attention when the developers are discussing coding guidelines. Don’t just chime in because the button in the UI has a misspelling, look at the UI as whole and think about how it can be improved. If you don’t know what a UI is…LEARN. Technical writers always have to keep their audience in mind as they write, use that perspective to help your fellow developers design a better product.
Finally, for managers, let’s be a little more careful when we put out a job req. I have seen many companies swing a little too low or too high on the techie pendulum. During the boomtime, many tech writer job requirements were slim and the salaries astronomical. I’m sorry my writer brethren, but having a degree in Journalism or History just doesn’t cut it. Yes, many of us came from various backgrounds, but for heaven’s sake at least get certified! What do you have to lose? On the flip side, I see quite a few job requirements that are flat out ridiculous and the salaries comical. You don’t need a Master’s degree in Computer Science to write an SDK Guide. I don’t care how complex you claim your product is.
But what do I know? I’m just a writer.
About this entry
You’re currently reading “Why Aren’t All Technical Writers Technical?,” an entry on I’m Just a Writer…
- Published:
- 7.18.08 / 5am
- Category:
- Rant
- Tags:
- technical writer, Rant, discussion, debate, dot com, dot com boom, dot com bust
3 Comments
Jump to comment form | comments rss [?] | trackback uri [?]