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

How Sticky Is Membership on Facebook? Just Try Breaking Free - New York Times (You may need a free account to read that article) Okay, I'm on Facebook. I have aHow long will your face be on Facebook?

Before jumping into the new stuff, just a quick note on the second episodes of shows that started last week... Heroes - an improvement. I both enjoyed and was annoyed byPremiere weeks 2009, part 2 - SGU and Clone Wars

finslippy: Give me your worst parenting stories [Found through ParentHacks] Holy cow, this is the funniest and saddest thing I have read or seen in the last year. It's a good thingBad parenting confessions

SCI FI Wire | The News Service of the SCI FI Channel Warner Brothers announced that its upcoming sequel to 2005's hit Batman Begins will be called The Dark Knight andThe Dark Knight - Batman sequel

[caption id="attachment_1036" align="alignright" width="285" caption="Harry Potter and the Half-Blood Prince"][/caption] I haven't read the books. In general I've tried to avoid reviews and other spoilers for the film (though I didReview: Harry Potter and the Half-Blood Prince

[tag]Christian Bale[/tag], [tag]Michael Caine[/tag], and [tag]Christopher Nolan[/tag] (all of whom worked on [tag]Batman Begins[/tag]) join [tag]Hugh Jackman[/tag] to create one of the best magician movies I've ever seen. Actually, thisReview: The Prestige

Trailer for 11 Minutes Ago The first thing that impressed me about this movie was that it was shot, in it's entirety, in a single day. For a feature length film11 Minutes Ago

Gone are the heady, playful days of American Ninja, and Ninja III: The Domination. These days, Ninja movies are more serious business, focusing on the real historical Ninjas, like theNinjas in history

What follows is a guest post from my wife, who has had a bit of a difficult week so far. I have come upstairs to ... get AWAY from our 2It's Not Fair!

You never know what's going to make an impact on your kids. I don't mean an immediate "wow!" impact, I'm talking about the long term stuff. It may not even2 voices + 4 spices = 1 big impact

Facebook is a place where absolutely nothing of importance happens. But you do get to see some funny, or at least interesting, posts from time to time. Here are someFound on Facebook

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

I've got one year to make up my mind. Maybe it won't seem like as big of a deal then. But for right now? I must have it. I haven't beenCould this be the one?

Set up your own free storefront (referral included) It seems like there has to be a catch to this, but I haven't found it yet. Zlio.com is a service that allowsMoney for nothing, and discounts on online purchases - Zlio.com

NO! I am not talking about the insipid, rodent-filled name-stealer. [caption id="attachment_1224" align="aligncenter" width="300" caption="Why?! Why did they do it?!"][/caption] Similar to Lee's story in the blog entry that I'm blatantly rippingG-Force ROCKS!

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