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

“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”

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

Warner will follow Marvel model to develop new superhero films : Slice of SciFi [caption id="attachment_488" align="alignright" width="288" caption="Superman Returns darker"][/caption] Ever since Superman Returns was released, rumors were flying about theSuperman Returns, but not as expected

There's really nothing I can add to this, so without further ado... Star Wars on BanjoStar Wars Bluegrass

Star Wars: Video Catch the trailer for the August 15th Clone Wars movie. This debuted with Speed Racer tonight. This. Looks. Awesome. Click through and watch it.Star Wars: Clone Wars Theatrical Trailer

Craig Ferguson's Late Late show did a Doctor Who themed episode on Tuesday night. Craig cracks me up. And he's a true Doctor Who fan, too. Here's the "Cold Opening" and monologue: TheFerguson's Doctor Who show

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

Jason Bourne is at it again. Chasing down his past and removing people who get in his way with some amazing hand-to-hand take downs. The Bourne Ultimatum picks up right whereReview: The Bourne Ultimatum

(Grab your pacemaker, it looks like I'm making two posts in two days! Will the madness ever end?) A few things came to my attention today that I just couldn't waitWatchmen, Star Trek, and Star Wars (sort of)

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...

To review: I'm talking about an article on ZDNet that tries to make the case for streaming first-run movies to a home theater. In the first part, I laid outMovie Theater vs. Home Theater (part 2)

Usability in the Movies -- Top 10 Bloopers Jakob Nielsens Alertbox Obviously a slow day in the world of Usability. This has got to be one of those posts that JakobA slow day in the world of computer usability reporting

So this past weekend I got together with my brother and a bunch of college friends for a night of poker in Philadelphia. It was the first time this groupPoker night!

2012 has an impressive line-up of films. Time travel, mutation, gods, monsters, hobbits, technology, and sheer awesomeness all combine to create an almost inescapable desire to just set up an7 movies my mother has to worry about (and a bunch more)

I mentioned this a while back, but this guy decided to use the power of the internet to break Star Wars up into 15 second segments and have people submitStar Wars, like you've never seen it before

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