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

(Man, I'm actually burning through my movie picks this year. This is awesome - big thank you to my parents for babysitting.) Tonight my wife and I settled in for theReview: Captain America

Hero - it's a nice boy notion that the real world's gonna destroy. - Steve Taylor In the last couple of days I've seen two blog entries from totally unrelated blogs aboutHeroes?

(Holy cow, was today Tuesday?! What happened to last week?) The new animated Green Lantern movie, First Flight was released last week. Here are the first four minutes of the film... MovieGreen Lantern: First Flight (and other Green Lantern news) - Tuesday TubeWatch

There is a lot going on in the world these days. The pace of life is increasing at an amazing rate. The progress we are making is incredible, and thereStop everything

Nothing new going on here. I created the map for a project at work, and I wanted to test out the embedding plugin bubbl.us has for WordPress. So, for what it'sMind Map of Learning Technologies

Hey... just a quick note to anyone following this blog in a feedreader or email that if you don't get any more posts from me by Tuesday, you might wantMigrating feeds

I've been quiet on here for a couple weeks due to some time pressures. Lots to do during the lead-up to Christmas, as I'm sure you can all understand. IWhat I've been thinking

Taken from the Nov 30, 2007 edition of Mikey's Funnies WORST ANALOGIES...EVER Part 2 ~ The brick wall was the color of a brick-red Crayola crayon. ~ I felt a nameless dread. Well, thereThis post is like a bunch of words on a piece of paper, except it's electronic

Watchmen broke ground as a comic book/graphic novel. The movie was extremely faithful, with few exceptions, to the book. Is that a good thing? Going in to this film, I thought,Review: Watchmen

“Journeyman” Creator Quells Cancellation Rumors - Slice of SciFi A couple posts ago I mentioned that "Journeyman" may not air all of its produced episodes this year. Well, it turns outGood-ish news for “Journeyman”

Corporate Training & e-Learning Blog: Corporate Learning Forum is HERE! In the blog above, Jenna Sweeney talks about a new listserv for corporate training professionals - the Corporate Learning Forum. I receivedCorporate Learning Forum - why?

Seriously, where else are you going to get a combination like that? I've got three video clips for you today, and one of them is not fiction. See if you canFirefly is back, Singing Batman, and Cyborg Rats

It's time to reconsider Google | News.blog | CNET News.com It really might be time for some people to reconsider Google - at least Google's search and Google Maps. They areAre Google's day's numbered?

I'm trying out a new theme. There are definitely pieces of it I really like, but it's a radical change from what I'm used to. The biggest thing that mightYour opinion: new theme?

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