RE: Most annoying statement

Subject: RE: Most annoying statement
From: "Joe Malin" <jmalin -at- tuvox -dot- com>
To: "Tony Markos" <ajmarkos -at- yahoo -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 2 Mar 2006 10:33:36 -0800

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

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.com

To subscribe, send a blank email to techwr-l-join -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.


Previous by Author: RE: Just what do I need to know about lotus Notes?
Next by Author: RE: DITA possible for start-up/lone writer?
Previous by Thread: Troubleshooting Image borders in Word
Next by Thread: ADMIN Re: Call for Proposals


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


Sponsored Ads