Writing: better or worse after years on the job?

Subject: Writing: better or worse after years on the job?
From: "Nealon, Jessica" <Jessica -dot- Nealon -at- McKesson -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 18 Oct 2001 10:24:15 -0400

Keith,

I couldn't agree with you more on the clarity part of it. It does affect
your writing in other areas; I think for the better.

Some comments:

I don't worry that much about my grammar if my sentences communicate
effectively. That is, I've stopped turning myself inside out to not end
sentences on a preposition. If the user understands it better with a
preposition at the end, that's the way I write it.

The interesting thing that I didn't see discussed ( I don't think) is how
the longer you're on the job, the easier it becomes to lose touch with your
audience and that has an impact on whether you become a better or worse tech
writer over time. TC jargon has a way of creeping into your manuals when
you're not aware of it because you have become so accustomed to using that
jargon on the job in meetings, proposals, etc.

Ex: I consulted a senior writer here about what to call a GUI feature.
Because it had no title and wasn't a section, I referred to it as a "box,"
as in "move the data from the box on the left to the box on the right."
That was the best I could come up with. Her response was to call them
"window panes." As a writer, I can see that "window pane" is more
descriptive, elegant, and official than "box." The question is what does
the user think? I know that if I was the user, I would have no idea what
"window pane" referred to on the screen.

This becomes more difficult as you become more technical as well. The
technical terms start to creep in because you become so familiar with them.
It's a constant tightrope we walk.

Regards,

Jessica Nealon
Technical Writer
Paragon Product Assurance Group - CLT
> McKesson Information Solutions, Inc
>
> Confidentiality Notice: This e-mail message, including any attachments, is
> for the sole use of the intended recipient(s) and may contain confidential
> and privileged information. Any unauthorized review, use, disclosure or
> distribution is prohibited. If you are not the intended recipient, please
> contact the sender by reply e-mail and destroy all copies of the original
> message.
>
>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day.
For details and online registration, visit http://ieeepcs.org/2001

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.


Previous by Author: Rhetorical question about formatting devices?
Next by Author: RE: Most Impt. Skill to Learn in Tech Comm Program?
Previous by Thread: RE: Writing: better or worse after years on the job?
Next by Thread: Re: Writing: better or worse after years on the job?


What this post helpful? Share it with friends and colleagues:


Sponsored Ads