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

Hmm.... how do I do this without giving away spoilers? This was simultaneously the coolest and weakest of the three X-men movies. It earns coolest because it had some excellent battleReview: X-Men 3: The Last Stand

Cerado's Web 2.0 or Star Wars Quiz Sadly, I got a 38.Web 2.0 or Star Wars?

Dr. Horrible's Sing-along blog I made a quick mention of this once before after seeing the trailer. I just saw the first act (which was so popular it brought down theDr Horrible's Sing-along blog

I find a lot of stuff that I want to share, but that doesn't make it into a blog post of its own, for whatever reason (usually a lack ofLinkList: Sci-fi edition

Okay, yeah, the day's almost over, but you know how it is... things got away from me. The dog ate my homework. And then he did this: So there you haveBetter late than never (maybe): Tuesday TubeWatch

Traveling across the 'net as part of this commentluv contest, I ran across this really interesting site that went around to different cities asking 50 random people on the street:What's your wish for today?

In the 7 day challenge, today’s topic is: Create a blog post on a subject I’ve never blogged about here before. Maybe this one is cheating. I don't know. It depends onPlastic People - 7 day challenge

GateWorld - SCI FI confirms Atlantis cancellation, TV movie Stargate: Atlantis has been cancelled. The show will run through its 100th episode in January 2009 and end on a cliffhanger, whichStargate to die a slow, painful death

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

The MASIE Center - Learning Lab & ThinkTank - PodCasting for Learning Call I'm listening right now to this podcast. It's got a slow start, but there are some good ideasPodcasting for learning Podcast

Yes, I know stupider isn't a word. It applies to Netflix nonetheless. I'll start this off by admitting that I don't have Netflix. I have used it at other people's housesNetflix becomes stupider, Warehouse 13 returns

There is nothing more perfect than the punch line of this Dilbert strip. Who among us cannot relate? I actually considered making that my new theme on this site. There areWhat futility doesn't feel like

After a troubled history with Disney, 20th Century Fox has picked up the Narnia series and is moving forward. This December we'll be treated to the next installment in theBack to Narnia with a new trailer, and a 2010 movie update

G-Ding.TV | Viewing Linux in a whole new way For the cost of basic hardware you can have a PVR (Personal Video Recorder, e.g., TIVO) in your house. You can evenAlmost free TV / PVR

Today I left my house. No, really, it's true. There wasn't a computer monitor anywhere near me for hours. Well, okay, except for when we stopped at Best Buy, but other thanGeek field maneuvers (without the proper tech)

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