eandrews

Tech Writing, I Guess

- 2 minute read

What is a Tech Writer? How does one write “technically”? I thought it’d be an interesting experiment to answer these questions now, so that in a year or two I can reflect on how my view has changed.

My understanding of what a Technical Writer does has already changed from when I was first exposed to the role.

When I started my software developer apprenticeship, I was required to visit each company department to learn who they are and what they do. One of these was “Technical Writing”. After the sole Technical Author explained his role, I asked him “So, what’s your WPM? You must be a pretty fast typist right?” After which, he tactfully explained that Tech Writing is not about quantity; it’s about quality and clarity. Indeed, from him I learned this maxim: “Treat every word like it’ll cost you $10.” The notion here is not to write as few words as possible, rather it is to carefully evaluate the cost of each word, and to maximise their efficacy.

Methinks

Technical Writing, to me, is clear and concise communication about a technical subject. The primary medium is text, but because the main goal of a Tech Writer is to inform clearly, they should skillfully use any medium to educate their audience. If a graphic (e.g. a flow chart) can explain the sequence of a process in a clearer way than a bulleted list, then the Technical Author would choose the flow chart.

I have now realised why some refer to Tech Writers as “Tech Authors”; a Tech Author is not only a writer but an author of technical “stuff”. This Author chooses whichever medium will best convey what he is trying to express.

I’m yet to see if I aspire to be Tech Author or a Tech Writer. When I originally fancied trying Technical Writing, I did not think of the other mediums. Perhaps then, a Tech Author’s chief motivation is to inform, rather than to write.

I wonder if, in future, I’ll read this post with a grimace. I wonder if I’ll read it at all…

#tech_writing