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 follow football. At all. Never have. Most of the time I'm surprised to learn that the Super Bowl is on. I used to appreciate the commercials and watched mostlyWhy I loved last night's Super Bowl

Generally speaking, when you're with a bunch of guys you can always count on one topic of conversation coming up: sports. Every guy watches sports, right? Maybe not all sports,My superpower, or why I don't watch sports

JMSNews J. Michael Straczynski, the creator/writer/producer of Babylon 5 and Crusade, has been writing for television for twenty years. He's been pretty successful at it, too. He doesn't just write forJMS deluged with attention

Back in April I wrote a list of the movies I want to see this year in the theater. So far I've seen all the ones I called as aSummer Movie List 2 - Revenge of the Trailer

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

Ever since "Ikea" popped up on one of my Pandora stations months ago, it's been one of my favorites. Every time I hear or see words like "Ikea," "Thor," or "Norsemen"Tuesday TubeWatch: Ikea and Jonathan Coulton

Looks like I am officially blogging. I am too cool for words. (Ironic, isn't it.)Check it out...

In Minority Report, Tom Cruise's character was able to interact with a very cool looking computer desktop that he could manipulate with special gloves just by waving his hands around. [captionTuesday TubeWatch: Minority Report to Sixth Sense to PHUD - Interface Advancement and Integration

This is just a list of things I saw today that you need to see. Doctor Horrible, Act 1, the 8-bit Nintendo version: Mail truck converted into a Colonial Viper (original BattlestarStuff you just need to see

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

15 Minute Lunch: Strap in, shut up and hold on. We're going back. It's almost shocking anyone survived the 1970s. There should have been some kind of ritual suicide for lookingGrab your Hardy Boys lunch box - here come the '70s

U.S.S. Mariner » Bugs Bunny, greatest banned player ever This just blew me away. First of all, if you've never seen the referenced cartoon, you're missing one of the greatestFirst base: Bugs Bunny; Second Base: Bugs Bunny...

I'm of two minds about this movie. On the one hand, it was extremely well done, especially the directing and acting, and the subject was enticing and kept my interest.Review: The Aviator

Two years ago we caught my then 2-year old daughter slathering herself (and the rug, and the covers, and the bed) with Desitin cream. My resulting distress was recorded inWhat is it with this kid?

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

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