Re: Technical Writing - What's the catch?

Subject: Re: Technical Writing - What's the catch?
From: Dick Margulis <margulisd -at- comcast -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 01 Apr 2005 13:17:17 -0500




Brian Jennings wrote:

I'd recommend checking out an essay by Orwell that, I think, better
explains his reasoning behind the rules. I guess you don't have to agree
with him, but I like his advice. This is where I was exposed to them and
they are a little different than those provided.

Orwell says a writer should ask himself:
1. What am I trying to say? 2. What words will express it? 3. What image or idiom will make it clearer? 4. Is this image fresh enough to have an effect?


And that list is quite revealing of the difference between self-expression and technical writing.

For most of us the questions are something more like this:

1. What is the audience?
2. What information do they need?
3. What is the clearest, simplest way to convey that information to the audience I've identified?

The focus changes from projecting my oh-so-important self into the culture to getting information to the people who need it. Orwell isn't wrong, if the advice is directed at the budding memoirist, novelist, or poet. But it is not the right advice in this forum.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l

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



Follow-Ups:

References:
RE: Technical Writing - What's the catch?: From: Brian Jennings

Previous by Author: Re: who is a native speaker was RE: Displays vs. Appears
Next by Author: Re: Documenting Hardware....yikes
Previous by Thread: RE: Technical Writing - What's the catch?
Next by Thread: Re: Technical Writing - What's the catch?


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


Sponsored Ads