When Tech Writers Don’t Read Directions

March 22nd, 2008

The common perception that all technical writers do is produce instructional manuals isn’t totally undeserved; after all, that is where the profession got its start. While the field of technical communication has branched out considerably, a technical communicator’s job still involves giving directions of some sort.

It can be a little exasperating when people run into trouble because they tried to accomplish a task without reading the instructions that the technical writer crafted so carefully. Therefore, it stands to reason that the same tech writer would take the same care in reading and following directions himself. Given his understanding of the one who produced the instructions, a technical writer ought to adhere to the Unspoken Rule, which is to give deference to those instructions.

I violated the Unspoken Rule myself twice this week in regard to the Society for Technical Communication.

Allow me to note here that a technical writer opens a set of instructions with an entire additional set of expectations than other users or consumers. That’s a topic for another time.

My first crime against the Unspoken Rule occurred when, having a month’s notice by way of flyer and a duplicate reminder a week ahead of time, I failed to RSVP for an Intermountain STC Chapter event. I realized the next day that I hadn’t done so; in fact, I couldn’t even remember having mentally registered the fact that an RSVP was necessary.

Second, having recently rejoined STC after a break since being a member of the Utah State University student chapter, I didn’t receive login information for the Web site. I couldn’t remember my previous login information, so I entered my email address in the form that will kick off an email with a system-generated user name and password. However, I failed to read the information above the email field, which indicated that the password would be temporary.

I didn’t get around to changing my password until, a week later, I tried to log in and couldn’t, and I ended up getting locked out. Fortunately, the Webmaster was very prompt in resetting my account once I sent an explanatory email. But, once again, my failure to adhere to the Unspoken Rule caused me some inconvenience. (I did reset my password immediately this time, by the way.)

No manual needed?

When I violate the Unspoken Rule, I feel embarrassed and even a little hypocritical. As a technical writer, I ought to afford my fellow communicators the attention that their directions deserve. In turn, I expect the same courtesy. If we can’t trust other technical writers to follow our instructions, whom can we trust?

Related entries (auto-generated):

Whether or Not to Read Aloud in Reviewing My Content

Giving the Instructions a Fair Shot

Ten New Year’s Resolutions for Technical Writers

More Than a Technical Writer

Undiscovered Instructions Aren’t Much Good

5 Responses to “When Tech Writers Don’t Read Directions”

  1. Timber Says:

    I love the cartoon. Are women Tech Writers just as bad about reading directions as the men? I hate going into something without knowing exactly what I’m doing. I love intelligible directions!

    [Reply]

  2. Tom Gorski Says:

    Ben,

    I enjoyed your piece on the Unspoken Rule. I think many folks can relate to your admission and suggestion to trust your colleagues.

    Would you mind if we used the piece (or portions) in one of our publications? I’m also interested in the cartoon as well.

    Tom Gorski
    Director of Communication & Marketing

    [Reply]

  3. Tom Gorski Says:

    Ben,

    Sorry…I thought there would be an automatic identifier with my response. I am the Director of Communication & Marketing for STC and was referring to possible use of your piece in Intercom or one of our electronic newsletters.

    Tom

    [Reply]

  4. How to Get Your Blog Mentioned in the Society for Technical Communication’s Intercom: Include the Word “Technical Communicator” | I'd Rather Be Writing - Tom Johnson Says:

    [...] ago, my friend Ben Minson, also a technical communicator, mentioned that a post on his blog — “When Tech Writers Don’t Read Directions” — caught the attention of Intercom editors as well, and they asked to publish an excerpt in [...]

  5. sameera Says:

    I think somewhere we all are guilty of having done something similar to what you did. :)

    [Reply]

Leave a Reply