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

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

I couldn't think of a good category here. Sue me. Do you know? Great little tidbits of thought-provoking information about the state of the world and the rate of change, set toLinkList: Generic edition

Afternoons with Amit: How to watch TV online...legally See, that's the kicker - doing it legally. Anyone can find illegal TV. Given the option, though, I'd much rather support the companiesTV online - legally

Easily the funniest of these kinds of things I've run across... see more crazy cat pics There needs to be a Hitman Monkey comic book. A depressed monkey running around whacking people...Hitman Monkey

This post is all about me feeling better about myself and bragging a little. If you can't handle that, well, sorry. I promise the next post will get back toStatistics and Ego Stroking

I'm late for leaving on a trip, so this will be quick. The Dark Knight Rises is a completely worthy capstone to the Nolan/Bale Batman trilogy. It turns the trilogy intoReview: The Dark Knight Rises (no spoilers)

SCI-FI to SCI-FACT: A Working “Spider Man” Suit - Slice of Scifi A “Spider-man” suit that enables its wearer to scale vertical walls like the comic and movie superhero couldWho's that wall-crawler?!

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!

Long-distance callers have some money coming - MarketWatch Make any long distance calls in the last three years? Claim your cash in 2007! The repeal of the Federal excise tax (initiated inClaim some long-distance cash!

Another year has gone by, and more fathering lessons have been learned. Hopefully my kids have learned a bit, too. For my part, I've learned - perhaps more than in otherHappy Fathers Day

SoSF Interview With the “Tin Man” Creators Steven Long Mitchell and Craig Van Sickle - Slice of Scifi Yeah!!! Here's some hope for "The Pretender" fans... can't wait to hear more"The Pretender" to continue/conclude online!!

Okay, look, here's the thing: Doctor Who travelling to some alternate reality where he meets Bugs Bunny would be incredibly cool in a very strange, and possibly acid-induced way. It'sTuesday TubeWatch Two-fer! Doctor Who meets Bugs Bunny!

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

“24″ Casulty of Writer’s Strike - Slice of SciFi Due to the Writer's strike, many shows are considering their options. Apparently "24" decided to throw in the towel on this year. Jack's dead - again - but he'll probably be back

It's possible that you've noticed that I don't post a lot here anymore. This blog has admittedly fallen mostly into disuse. This should not be a surprise to anyone. It occursWhere I've been

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