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

So I've been on Google+ (Google Plus) for a little while now. For those who don't know, it's another social media platform, like Facebook. You make a profile, then youGoogle+ is open - is it a better Facebook?

Through watching the Randy Pausch lecture (mentioned in my previous post) I discovered a great free tool for learning how to program, called Alice. What's different about Alice is thatAlice: Through the Monitor (or Creating new worlds for Novices)

Our National Savings Rate Is Embarrassing [Fool.com] January 17, 2007 Wow... this was surprising to me: ...consider these historical numbers for the U.S. personal savings rate: * 1984: 10.8% * 2001: 1.8% * 2003: 1.4% DoU.S. National Savings Rate breaks a bad barrier

Today's my birthday. Woo hoo! I managed to not die again this year! (I'm really not sure where I'm going with this post, but I figured I might as well useBirthday ramblings

Democrats in 2 Southern States Push Bills on Bible Study - New York Times A couple of Democrats are endorsing a Bible class in public schools—but only if it's based on"Bible bill" sponsored by Democrats

The New York Times reported last week that Abdul Qadeer Khan may have sold plans for a nuclear weapon: American and international investigators say that they have found the electronic blueprintsKhan set us up the bomb!

Smallville's a repeat tonight after the mid-season cliffhanger two weeks ago. Not sure where the plot is going? Come on... Chloe is still possessed by Brainiac, Doomsday is a ravingSmallville fix

Today held a couple of movie 'firsts' for me. I didn't see either of them coming. The first 'first': I went to a movie alone. The second 'first': I left before itThe #1 reason to walk out of Inception is...

There really isn't much I can say about this... it's one of those painful things that happens at sci-fi conventions. But you gotta see the third act. [kml_flashembed movie="http://www.youtube.com/v/UkTQwP2gFxU" width="425" height="350"Vader is thrilling

Orci & Kurtzman Tackle Man of Steel - Slice of SciFi Bryan Singer is in talks with writers for the next Superman movie, "The Man of Steel". Unfortunately, we have toSuperman returns... again

In my last post, I mentioned a definition of e-Learning I wrote a few years ago. For the record, this is what I said: How do you define e-learning? What areDefining e-Learning

There are some out there who would call this "weak 3" of the show. This is definitely the slowest pacing of a Stargate series yet. The premiere was good, butStargate Universe, week 3, Darkness

We're heading back toward another season of Doctor Who! Matt Smith will reprise his role as The Doctor starting on Easter weekend (April 23rd). Also returning are companions (and newlyweds)Doctor, Doctor, gimme the news...

For the first time ever, this blog is involved in a contest. This isn't like a "who's got the best blog" kind of thing, but one that gives you theWill you win?

I knew that I knew it from somewhere. It sounded familiar, but I couldn't place it. Now I know. The Olympics stole their theme song from the opening credits ofWhat do Bruce Campbell and the Olympics have in common? - Tuesday TubeWatch

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