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

First of all, I have to say how shocked I am that I'm mentioning this before Lee. Somebody must have him locked in a very nasty dungeon. Good luck withIron Man 2 trailer released

Creating Passionate Users: REAL motivation posters This is stuff I've talked about with co-workers years ago: the "fake-ness" of motivational posters. The examples Kathy created are hilarious and truthful. ThereCreating Passionate Users: REAL motivation posters

My friend and I first saw this movie in the mid-eighties on the recommendation of a video store clerk. That was probably the best tip we ever got from aReview: Sleuth

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

Apple - Trailers - Iron Man - Trailer - Large Hey, the trailer for the May 2008 movie is out! Looks good, but I'm not totally sold yet. I'm a littleIron Man - Movie Trailer

1500 Filipino Inmates Do Thriller - ectoplasmosis There is something disturbing about that guy playing "Michael Jackson's" girlfriend... actually there's something disturbing about the whole thing, but I just can't stopThrilling times for Filipino cons

2theadvocate.com | Suburban | Deputies: Owner shot out man’s tires when he couldn’t pay for gas People are so screwed up. Take a second and write down the guy's license plateMan steals gas; Man shoots cars tires

I'm curious what you all use for your RSS feed readers. How do you keep track of the blogs you read? If you choose "Other" leave a comment below and letNew poll on Feed Readers

I've posted before about the Green Lantern movie(s) in the works. No cast has been announced, no real information has come to my attention at all about the live actionNathan Fillion as Green Lantern? - Tuesday TubeWatch

Just saw this and had to share it. I hear it's been around for a while, but it's really cool that we can track where on a computer screen the"Gaze Tracking"

I'm winning! That's the excitement of Andy's commentluv contest. Every comment on every participating blog is an entry. I've lucked into winning twice now. The first win was, ironically enough, onI won again!

Learning 2006-2005 Information - Free PodCasts Video - CNN Pipeline I don't have a subscription to CNN Pipeline, but from what I'm seeing here it appears to be really interesting technologyCNN Pipeline: A learning perspective, & Blogs in learning

Top five shows that shouldn’t have been cancelled - Quit Your Day Job: Lee came up with a good Friday Top Five this week. What are the 5 best shows thatThe best cancelled shows

Okay, look, here's the thing: Doctor Who travelling to some alternate reality where he meets Bugs Bunny would be incredibly cool in a very strange, and possibly acid-induced way. It'sTuesday TubeWatch Two-fer! Doctor Who meets Bugs Bunny!

The Simple Dollar » Everything You Ever Really Needed to Know About Personal Finance on the Back of Five Business Cards Lately I've felt like Trent was recycling the same advicePersonal Finance on 5 business cards

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