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

Monkey Bites The post is missing a few details (perhaps because they aren't available), but it looks like the popular Eudora email client from Qualcomm is being completely re-written, using theEudora goes Open Source

[caption id="attachment_562" align="aligncenter" width="600" caption="Kirk and Spock over the Enterprise"][/caption] First off, if you haven't yet, go see the trailer. This one is worth the HD download. It's pretty. Okay, back already?Star Trek (2009) full trailer released

Well, my last sci-fi news post was a bit late, but all this news is at least recent-ish. :) First off, two bits of Battlestar Galactica related stories: The Sci-Fi channel hasMore recent sci-fi updates

My wife cheats. There is no way she's done this without cheating. See, it started out innocently enough. She started putting up cute little statuses on Facebook about the things our kidsCheater!

SCI FI Wire | The News Service of the SCI FI Channel As previously reported, Fox and Universal Studios have backed out of their deal to finance Halo. While not ideal,HALO movie - on pause

Official Google Reader Blog: There's a feed for that?! I've never actually used Craig's List, but the article linked above points out that you can use feeds from that site andJob Search via RSS

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

FOR WHAT IT'S WORTH | Bryce Zabel: Superman Returns (2006) vs Superman: The Movie (1978) Here's a great review of Superman Returns in comparison with the original Superman movie (I loveBryce Zabel's Superman Smackdown

No, I haven't read the entire series in the last 12 hours. I have, however, read an excellent article that explains how much of my disappointment in the finale ofReview Addendum: Harry Potter and the Deathly Hallows, pt 2 - book comparison

TheForce.Net - Latest News - Number One Star Wars Fan In The UK I really like Star Wars a lot. I've spent way too much money and time on it overStar Wars fanatacism

United Press International - NewsTrack - Some telecommuters work in the nude For your sanity, I will stay silent on which category I am in...Working in the buff

First, sorry about the absence of new posts lately. Plenty has been going on, I've just been too tired to write about it. Anyway... on to the review! The Rocky seriesReview: Rocky II

Just a couple of examples of life with Little Mommy... Sometimes I don't give my kids enough credit Recently Little Mommy and I were putting together a puzzle on the living roomLittle Mommy moments

[caption id="attachment_730" align="alignright" width="300" caption="The Dark is Rising sequence"][/caption] When the Dark comes rising, six shall turn it back; Three from the circle, three from the track; Wood, bronze, iron; water, fire, stone; FiveThe Dark Is Rising, except on film (Review: The Seeker)

Catch Up to Season Four | Battlestar Galactica | SCIFI.COM Looking for a quick reminder after the two decade wait between season 3 and the finally about to debut season 43 years in 8 minutes - BSG

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