29 Jan
Posted by Scott as technical communication, writing
Every two weeks, Aaron and I hold a virtual meeting. We get on Google Talk, catch up, and talk business. The last time that we did this, we were discussing some matter or another and one of us said “I wish I’d known that when I started in the profession.” In a series of blog posts over the coming weeks, we’ll be sharing some of that kind of information.
The first bit of advice is that knowing how to write isn’t enough. The ability to write well helps, but there’s more involved in being an an effective technical writer.
One of those skills is information design — how to structure and chunk information in a way that your readers will find useful. Good structure goes hand in hand with with audience being able to understand what you’ve written. Which bring us to the next skill …
You really need to be able to write tightly. Documentation isn’t like a novel or an expository essay. The goal is to teach the reader to perform a task as quickly and efficiently as possible. A few too many words hinders that process. While you will have sections of background information in the documentation that you write, those too should be as concise as possible. You might want to listen to the podcast that Aaron and I did on common writing mistakes for some pointers.
Technical skills are important, too. Start by learning the tools of the trade, like FrameMaker, Flare, and even Microsoft Word. Then, tackle the other skills that revolve around the operating systems, applications, and languages that are used where you work or may work in the future. Aaron and I devoted an entire podcast to this subject, which could be worth a listen.
In order to get information, you’re eventually going to have to interview the elusive and sometimes dangerous subject matter expert (SME). Good interviewing skills are definitely something to develop. Tom Johnson penned a blog entry listing 10 tips for perfecting interviewing skills. While Tom’s post is aimed at podcasters, you can adapt the information to interviewing your SMEs.
Update: In the time since this post was written, Tom Johnson has published an excellent interview on going beyond technical writing. It’s definitely worth a listen. You might also want to take a listen to another podcast on this topic.
Related posts:
6 Responses
Stephanie
April 26th, 2010 at 6:49 pm
1I started in the technical writing field almost 1.5 years ago. Writing, in conjunction with in-person and virtual classroom training, amounts to about 90% of my job. A few months ago, I was made lead of my department and given this opportunity I would like to standardize writing styles for the benefit of my subordinates and those who come after me. After several days of researching the web and a few professional websites, there doesn’t seem to be any agreement on the style of technical writing, whether it’s MLA, AP, Chicago, etc. Furthermore, I realize this can be complicated depending upon the entity you are writing for as writing for the Federal Government would necessitate the use of 508 compliance guidelines, but do you have any suggestions on which style guidelines should be followed when writing user guides?
Scott
April 26th, 2010 at 7:39 pm
2@Stephanie, good question. I have no real preference as far as style guides go. Most of the people I know use either The Microsoft Manual of Style or Read Me First (Sun Microsystems).
Tell you what, I’ll toss this question to the Twittersphere and see what happens.
Tweets that mention Advice for the novice tech writer: writing isn’t enough by Communications from DMN -- Topsy.com
April 26th, 2010 at 7:57 pm
3[...] This post was mentioned on Twitter by DMN Communications, DMN Communications. DMN Communications said: Got a question on the blog about which TC style guide to use – http://bit.ly/cDaxQP Can anyone make a suggestion? [...]
Marie-Louise Flacke
April 27th, 2010 at 1:51 am
4Suggestion: Developing Quality Technical Information, A Handbook for Writers and Editors – IBM Press / Prentice Hall (Second Edition)
ISBN 0-13-147749-8
Marie-Louise Flacke´s last blog ..New to proposal writing?
Stephanie
April 27th, 2010 at 8:21 am
5Thanks for your help – I’ll look into those right away.
@ Scott – great blogs btw – easy to read and they give great practical insight.
uberVU - social comments
April 28th, 2010 at 12:03 pm
6Social comments and analytics for this post…
This post was mentioned on Twitter by dmnguys: Got a question on the blog about which TC style guide to use – http://bit.ly/cDaxQP Can anyone make a suggestion?…
RSS feed for comments on this post · TrackBack URI
Leave a reply
Blogroll
Past Entries
Communications from DMN is proudly powered by WordPress - BloggingPro theme by: Design Disease