RE: Idiotic Tech Writing Prize

Subject: RE: Idiotic Tech Writing Prize
From: "Downing, David" <DavidDowning -at- users -dot- com>
To: "Bill Swallow" <techcommdood -at- gmail -dot- com>
Date: Mon, 26 Jan 2009 11:46:41 -0600

-----Original Message-----
From: Bill Swallow [mailto:techcommdood -at- gmail -dot- com]
Sent: Monday, January 26, 2009 12:04 PM
To: Downing, David
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Idiotic Tech Writing Prize

> We need to make the distinction between faulty *writing* and faulty
> *logic.* Something can be very well written and still be totally
> illogical.

I would argue that technical writing leans heavier on the logical side
than the well-written side. Technical writing is not about beautiful
prose. It's about getting the right info to the right people in the
right manner at the right time for the right reasons.

--
Bill Swallow
http://techcommdood.blogspot.com
http://twitter.com/techcommdood

Avid homebrewer and proud beer snob.

--------------------

I don't have any argument with that. There are a number of practices
that are common in technical writing, such as the use of sentence
fragments, that blatantly violate the rules of good grammar and elegant
prose. In fact, one rule I had to unlearn is to vary your wording when
repeatedly referring to the same object or idea. In technical writing
you *must* use exactly the same wording each time you refer to a given
object or idea.

My point was rather that you have to be careful not to be swayed by a
piece of writing that is elegant prose, but says something completely
illogical or outrageous. In fact, I remember one of our SMEs rejecting
something I'd written because, "I suddenly realized this was written
very well, but didn't describe what the software really does," or
something to that effect.

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

ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.
http://www.doctohelp.com

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Re: Idiotic Tech Writing Prize: From: Downing, David
Re: Idiotic Tech Writing Prize: From: Bill Swallow

Previous by Author: Re: Idiotic Tech Writing Prize
Next by Author: RE: Idiotic Tech Writing Prize
Previous by Thread: RE: Idiotic Tech Writing Prize
Next by Thread: RE: Idiotic Tech Writing Prize


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

Sponsored Ads


Sponsored Ads