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

I don't have a pet. Dog, cat, fish, bird, rock... nothing. That's not likely to change in the next 5-7 years, if ever. There are lots of reasons, actually, butWhy I don't have a dog

SCI-FI to SCI-FACT: A Working “Spider Man” Suit - Slice of Scifi A “Spider-man” suit that enables its wearer to scale vertical walls like the comic and movie superhero couldWho's that wall-crawler?!

It's a popular debate lately: are these social networking sites (Facebook, Twitter, MySpace, etc.) bad for us? Recently an Oxford professor, Baroness Susan Greenfield, made some rather provocative speculations aboutTuesday TubeWatch: Social networking will eat your brain!

As I mentioned in my last post, I've recently reconnected with a lot of friends from my high school youth group through the wonders of Facebook. It's been a lotFacebook points to the past, and I consider the future

I'm a little hesitant to review this one, because it doesn't feel like it would be fair to do so until I've seen part three and the end of theReview: Pirates of the Carribean: Dead Man's Chest

FOR WHAT IT'S WORTH | Bryce Zabel: Produce or Perish! | USC School of Cinema & Television CNTV589 Bryce Zabel is going to be a professor at USC. If his classBryce Zabel: Those who can, teach

It's possible that you've noticed that I don't post a lot here anymore. This blog has admittedly fallen mostly into disuse. This should not be a surprise to anyone. It occursWhere I've been

Like The Matrix, you cannot be told what this is. Words cannot describe it. It must be experienced. You must immerse yourself in it to feel the awesomeness. Soak it in: Seriously,The most awesome thing to come out of India - ever

Back in January, there was a major disaster in the world. Perhaps you heard about it? There was lots of media coverage. This isn't a trick question. I'm talking about theWalking the talk

First, the confession: I've been a Doctor Who fan since I was about 8 years old. Sitting and watching those episodes (Tom Baker, at the time) with my Dad isReview: Doctor Who 2005 & 2006 seasons

AAA has nothing on these guys

Diabetes breakthrough Before you get too excited, let me say this: from my read of the article, it's a long time before humans could benefit, and even when they can, you'llA cure for Type I diabetes?

Slice of Scifi - Science Fiction TV & Movie News, Interviews & more » Paraglider Sucked Into Killer Storm Wow. This definitely qualifies as the craziest story I've heard about paraglidingFlying woman freezes, falls, and survives

Silence. That's all I was after. Just make the screaming stop (and prevent me from adding to it) - nothing else mattered. While the challenge presented by my youngest childThe Silence of the Lamb

Tonight the girls and I were playing games like Simon Says, Follow the Leader, and Climb All Over Dad Until His Arms Fall Off. We had almost moved into HideWeeping Angels game

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