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

Wow! I'm geeking out! This guy managed to mix computer laptop maintenance and an Ultraman-like tribute into a catchy, funny song! He even got a Queen tribute in! Hats off toClean the fan, with Ultraman

FOR WHAT IT'S WORTH | Bryce Zabel: Spaced Out: Hawking Colonies & Re-Booting Star Trek Bryce Zabel (Dark Skies, Lois & Clark) and J. Michael Straczynski (Babylon 5, Crusade, Jeremiah) wereStar Trek, Babylon 5 style: Concept pitch revealed

This week I had two days completely to myself. My wife took the girls with her to her sister's house early on Monday, and got back very late on TuesdayIt's official. I'm boring.

I know you didn't notice, but I did. This site was down for about 20 hours due to a glitch that showed I had overspent my bandwidth allocation. I hadn't,We're back, and better than ever in "We're back, and better than ever!"

I don't have it in me to write everything I think about this movie right now, but I wanted to get something down. Just like Spider-man 2, this sequel takes anPseudo-Review: The Dark Knight

Easy Meal Prep Association and Meal Assembly Directory I'm looking for ways to live cheaper. I got a tip in the comments of another blog to check out a Meal PreparatoryIs a meal preparation service a good deal?

So your co-worker comes over and says, "Hey, you going to lunch today?" You say, "Sure. Where do you want to go?" "Well, there's Joe's Chicken Shack, or The Hungry Heiffer, orWheel of Lunch!

Yeah, I know it's January, but I just saw this and couldn't pass it up. Wow. I appreciate the sentiment, but this is someone with WAAAAY too much time (and money)A late Christmas overload

One or two of you may have noticed the frequency of posting here has dropped quite a bit in the last few months. I thought I'd comment on why... It's aWhere I've been

Three years ago today, at 11:48pm, I wrote these amazingly insightful words: Check it out… Friday, December 9th, 2005 Looks like I am officially blogging. I am too cool for words. (Ironic, isn’tThree years of yammering on...

Okay... that was one moody episode of Battlestar Galactica. Fair warning. If you haven't seen the first of the final 10 episodes, turn back now. There be major spoilers ahead. So...The fifth Cylon - say what? (w/spoilers)

The Complete Guide to Free Music Online Legal Edition Especially if you're looking for new artists, this list will help you out. Everybody likes free music, right? [tags]free stuff, music, download, mp3[/tags]Free legal music downloads

Though it didn't do too well in the box office, this movie worked for me - all the way until the last scene. The end was the one place whereReview: Firewall

I've been holding off on posting my thoughts until I felt I had a real grasp for quality of the show. Well, I can now say that I firmly believeReview: Heroes Ep 1-3

In the 7 day challenge, today’s topic is: Write a blog post on the same topic as one of my most popular posts. By far, in both page views and comments, myHow to get Silly Putty out of clothes - 7 day challenge

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