TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
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.
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-