About me

I'm a geek working as a distance learning specialist for a large corporation.

My Pandora "radio station" profile
This is my favorite way to listen to music now.

My Yahoo "radio station"
(Unfortunately, only works in IE.)

Shopping

Looking to purchase something online? Support Caddickisms by going through one of these links:

Caddickisms Store

Amazon.com

Calendar

October 2008
S M T W T F S
« Sep   Nov »
 1234
567891011
12131415161718
19202122232425
262728293031  

Topics

Posts by month

Around the site

Okay, I've been remiss in getting the Doctor Who news out lately. 'Cause I know you all depend on me alone to let you know what's going on with thatDoctor Who/Torchwood news

Hey, guess what... this review will be completely devoid of jokes about having seen this movie before. Just wanted to get that off my chest. Off the top of my headReview: Deja Vu

“Justice League of America” Moves Forward - Slice of Scifi I'm sorry. I just can't picture this movie being made well any time in the next 5 years. As I said in“Justice League of America” Moves Forward - Slice of Scifi

Just prior to its theatrical release, I read the book upon which Martin Scorsese's Hugo is based, "The Invention of Hugo Cabret." The book is a beautiful story, told inReview: Hugo (and The Invention of Hugo Cabret)

To review: I’m talking about an article on ZDNet that tries to make the case for streaming first-run movies to a home theater. In the first part, I laid out the argument theyMovie Theater vs. Home Theater (part 3)

Unions had their day. They were a good idea when the worker was truly being exploited. These days, there are still areas where a union is probably useful, but forWhy I hate unions

[tag]Christian Bale[/tag], [tag]Michael Caine[/tag], and [tag]Christopher Nolan[/tag] (all of whom worked on [tag]Batman Begins[/tag]) join [tag]Hugh Jackman[/tag] to create one of the best magician movies I've ever seen. Actually, thisReview: The Prestige

The Learning Circuits Blog: Homeschooling and the Creative Class Hm... Until a few years ago, I didn't know much about homeschooling. Then I met my wife. Her brother and sister wereHomeschooling and education

[Note: recent events in my life have conspired to prevent me from putting together the vote scheduled for this week. I'll get back to it. It's not like you allTuesday TubeWatch: MacGyvering Star Wars

So here we have week 4 of Stargate Universe and week 3 of Sanctuary. As I mentioned last week, on SGU they're heading for a close encounter with a star. It'sSyFy shows reviews: SGU and Sanctuary

Slice of Scifi - Science Fiction TV & Movie News, Interviews & more » Failed Aquaman Tries On Green Arrow and The CW Network Announces Fall Premiere Schedule Smallville now hasSmallville: Green is in this year

Corporate eLearning Strategies and Development: eLearnDevCast New Episode with Karl Kapp - GGG4L - Recruiting Gamer Generation I just listened to a discussion between Brent Schlenker and Dr. Karl Kapp aboutCorporate Gaming: Recruiting and training

J. Michael Straczynksi, the creator of the 5-year TV series Babylon 5 in the 90's, has been doing little side stories from the B5 universe on and off since theBabylon 5 - the final word (mostly)

Interesting premise for this one: two people live in the same lake house, one in 2004, the other in 2006, and yet, with the help of a mailbox-cum-time portal, theyReview: The Lake House

This concept video was apparently leaked from Peter Jackson's production of The Hobbit. It's an exciting early look at the controversial direction Jackson may take, thematically: [kml_flashembed movie="http://www.youtube.com/v/XC73PHdQX04" width="425" height="350" wmode="transparent"Leaked Pre-production video for The Hobbit!

Technical writers, pay attention

New York Times columnist David Pogue has had two extremely good posts lately. One is aimed squarely at general computer users, and both are of great use to technical writers.

In the generally focused Tech Tips for Basic Computer Users, he points out things that all us geeks think everybody knows about computers. There are a fair amount that I didn’t know, however, so the list’s worth a look (though the article is so popular that it may have overloaded NYT’s comment system – the page took a really long time to load).

Here are two examples:

  1. Pressing ALT and the Tab key together in Windows will cycle you through all of your open programs. I’m frequently amazed when people don’t know that simple time-saver.
  2. Pressing ALT and F4 together will close the current window. So if you do it now, it will close this browser.

Takeaway for technical writers: Don’t assume your readers know these shortcuts. Be specific in how to perform required tasks.

The other article is good for any business writer, really, but it’s especially well suited to technical writers.

It’s really easy, as a writer, to slip into jargon. We’re comfortable with the specialized language and the meanings of all these words that confuse regular people. If you’re responsible for communicating with someone who doesn’t live and breathe in your corner of the world, though, you’ve got to be careful to use plain language.

Here’s an excerpt from Pogue’s article:

* Display. “Display” can be a noun (“a display of fireworks”). It can also be a verb that takes a direct object (“He displayed emotion”). It is not, however, a verb without a direct object, except in magazines like PC World: “Shows filmed in high-definition end up displaying in letterbox format.”

Displaying what in letterbox format? Fireworks? Emotions?

The word this writer was looking for is “appearing.”

[...]

* Enable. Who on earth says, “Enable the GPS function”? Only user-manual writers and computer-book authors. Say “Turn on GPS” instead.

[...]

* Functionality. WOW, do I despise this pretentious word. Five syllables–ooh, what a knowledgeable person you must be!

It means “feature.” Say “feature.”

I’ll add my own pet peeve here: Utilize. I want to scream every time I see this word. It’s another example of trying to sound smarter. It’s “use”. There is absolutely no difference in meaning. “Use” is much simpler and more common. That’s a good thing. Use it.

Oh, and while I’m talking about writing skills, here’s another tip for everyone, and it applies to speaking as well: be careful with clichés. If you’re not 100% sure you know it, don’t use it (or better yet – GASP – look it up!). Example: it’s not “for all intensive purposes,” it’s “for all intents and purposes.” “Intensive purposes” doesn’t even make sense. Think about what you’re saying. Most of the time, that will help.

Okay, I’m off to utilize the functionality of the TV remote control to enable the screen to display. For all intensive purposes, that should wrap up my night.

Tags: , , , , ,

5 comments to Technical writers, pay attention

  • found this post via your 3-years lookback..via Lee’s blog.
    Great post! I really hate it when I see words that could have easily been replaced by a far simpler word. Among those words are a lot of words directly used from English to Dutch..and ‘Dutchified’ ..just horrible.
    It’s always good to bear the technical writer stuff in mind because it’s partly my job to write decent texts (that is..when I’m done studying).

    Arjans latest blog post..A shadow of myself

    Reply to this comment

    Jeff says:

    Hey, Arjan… nice to see you.

    In a sick way I’m kind of happy that the problem exists in other languages, too… :P

    Oddly, I don’t typically get upset about Anglicized words. There are enough problems with people butchering English with English, I guess, that I just let those go as colorful.

    I’ve got a couple more “technical writer” posts in the queue, so you might want to watch for them.

    Reply to this comment

  • Jeff,

    When I read what you said about “utilize,” I cried.

    At last… someone who UNDERSTANDS!

    Reply to this comment

    Jeff says:

    Hallelujah! Thanks for leaving the comment. :) It’s good to know I’m not out there alone…

    Reply to this comment

Leave a Reply

  

  

  

You can use these HTML tags

<a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

CommentLuv badge