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

Creating Passionate Users Risk aversion can take a good idea and make it useless. And risk aversion is rampant in corporations. That's one of the points in Kathy's post. It's aRisk aversion can hurt you

I knew that I knew it from somewhere. It sounded familiar, but I couldn't place it. Now I know. The Olympics stole their theme song from the opening credits ofWhat do Bruce Campbell and the Olympics have in common? - Tuesday TubeWatch

I'm going to revisit a couple of topics discussed here recently and then we'll hit some new topics. Well, after my last post I finished watching The Event. I stick withRevisitation and new worlds

The Players: Dad - in the upstairs office, working Mom - ...indisposed 3-year old, aka "Little Mommy" - playing in playroom 2-year old, aka "Stinky" - playing in playroom So I'm sitting in my office,Little Mommy drops the... um... ball

I don't have a pet. Dog, cat, fish, bird, rock... nothing. That's not likely to change in the next 5-7 years, if ever. There are lots of reasons, actually, butWhy I don't have a dog

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

So we've got a new look here at the old blog. Not too drastic, but updated. I'm not finished tinkering, so things might change again soon. See if you canCh-ch-ch-ch-changes...

Star Wars: The Clone Wars | Star Wars: The Clone Wars In Theaters and on Television in 2008 The Clone Wars animated series is going to start with a theatrical release! ThisSend In The Clones!!!!

Back in January, there was a major disaster in the world. Perhaps you heard about it? There was lots of media coverage. This isn't a trick question. I'm talking about theWalking the talk

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

In the last month or so, it seems like Murphy is camped on my front step. Computer - dead. Motherboard, presumably, is fried, based on research. Car inspection - over $500 moreUnexpected costs, things that have broken lately, and lessons learned

[caption id="attachment_638" align="alignright" width="300" caption="The Dark Knight"][/caption] Christopher Nolan, director of The Dark Knight, has stated that he's in no hurry to make the second sequel to Batman Begins. He hasDark Knight takes it slow, plus Robot Chicken and Terminator

Stay on target. Some guys got together and built a scale model of an X-Wing fighter from Star Wars, complete with an Artoo unit. Then they strapped 4 rockets to it. Lock S-Foils in attack positions

Here's the thing about Michael Bay's Transformer films: from what I've seen, there's not much plot involved. With this new trailer I was hoping we'd get some semblance of plotNew Transformers trailer is nice but...

The Last Airbender's current ranking on RottenTomatoes.com? 6% Six percent. In other words, atrocious. Worse than 94% of all movies rated. Horrible. A steaming pile of excrement. Your mother would slapReview: The Last Airbender

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