This Technical Writing Exercise calls for paragraph styles: Learn how to style paragraphs and headings in Word or Google Docs using our custom worksheet.
The most important features for creative and technical writers in word processing software, with a checklist so you can pick just the ones that matter to you.
This Technical Writing Exercise calls for embedded tables: Learn how to build a table in your writing software of choice, and compare features of various tools.
Tweet Last fall, as I’ve said before, I had the opportunity to teach Technical Writing to a bunch of Computer Science students. It was what we called a “hybrid online course” — a Tuesday/Thursday class, but we only met in the classroom on Tuesdays. Then on Thursdays they would visit the class’s website, get the […]
Every document is, essentially, a phone call — a conversation between you and your readers, and you’ve got to establish a connection before you can start talking. I’ve said that before, haven’t I?
I’ve also said a good first draft is a block of marble, from which to carve that glorious statue known as a final manuscript. Oh, and telling instead of showing is the same thing as playing a game of poker with your cards on the table. Good document structure is a tower of red, yellow, and blue blocks. Poetry is magic, punctuation is alchemy, and so is blogging about your life.
Remember last week’s article about the shape of a document? Remember that hideous image growling out at you halfway down the scroll? Well, this week your assignment is to do one better.
Last fall I taught my first college-level writing course — Technical Writing at Oklahoma Christian University (my alma mater). My class consisted of a bunch of computer science and information technologies students, and a handful of English majors. It was an interesting mix.
I wasn’t out to teach them how to do my job. I did ask, first day of class, how many of them had considered becoming a Technical Writer after graduation. The answer (quite predictably) was none. When I got around to asking what they were planning on doing, every one of them named a profession that would require some proficiency with technical writing, even if it wasn’t their main job description.
Later this week, I’m going to spend a lot of time talking to the creative writers about poetry, and on Friday they’ll get to write sonnets. I wouldn’t expect sonnets out of my technical writers, but I still recommend that you take the time to read Thursday’s article, when it comes around. Poetry is language distilled, and technical writing is all about efficiency, brevity, and impact. The approaches are different, but the destination is the same.
So this week I want you to be poetic, too.
I’ve talked about finding balance in descriptive detail before, just as an example, but there’s certainly many more ways it’s true: balancing exposition against narrative, technical accuracy against brevity, clear prose against a finished draft. Those are pretty big-picture concerns, but it gets down to the fine details, too. Word length, sentence composition, punctuation marks….
My first job out of college, I was a Technical Writer for a small manufacturer in Tulsa, Oklahoma, that produced some of the world’s best fish finders. I spent several years writing user manuals for gadgets. Then I took a new job working for the Federal Aviation Administration, where I wrote maintenance instructions for the field technicians who service and maintain our nation’s long-range radars.