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.
Somewhere I was taught to avoid using "simple", "easy", etc. in
technical documentation, for exactly the reasons cited here. I have been
working with a book called (ironically) "The Definitive Guide to Plone".
Since it was written by a guru, it has this sort of frustrating offense
*everywhere*.
Joe Malin
Technical Writer
(408)625-1623
jmalin -at- tuvox -dot- com
www.tuvox.com
The views expressed in this document are those of the sender, and do not
necessarily reflect those of TuVox, Inc.
-----Original Message-----
From: techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Tony Markos
Sent: Wednesday, March 01, 2006 3:39 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Most annoying statement
My most annoying statement: "The procedure to do X is simple...."
Most of the time - especially in the "Dummies" books -when I read such a
statement, I find that the material that follows is incomprehensible.
Seems that often, when a writer does not understand what he/she is
writing about, he/she will preface the material with such a statement.
Evidently, the reasoning is that the reader will be so
embarrased/ashamed that he/she can not figure out such simple materials
that he/she will never think about complaining.
Tony Markos
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l