RE: Don't say what you CANNOT do in documents

Subject: RE: Don't say what you CANNOT do in documents
From: "Domaschuk, Rob" <Robd -at- datalogics -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 20 Apr 2004 09:32:58 -0500


John asks:

> ...what are the feelings about putting
> something you cannot do in a document.

Hi John,

This is a tough one for me, as I agree with yuo, but sales and marketing
people generally agree with your PM.

Here's the compromise that seems to work for me:

Technical documents (reference guides, spec sheets, etc.), I will use
language such as "ABC does not support the automatic shut down of cell
phones in restaurants."

User-based documents (User Guides, training manuals, etc.), I try to avoid
the "you cannot", because the moment you tell someone that "you cannot look
directly at the sun during a solar eclipse with our software", some bozo is
bound to call sales and ask that they be allowed to look at the sun.

I guess that while I don't see a problem with using "cannot", I really don't
care either way and since others do, I let them make that decision.

Of course, it can become a creative challenege finding ways to use positive
language when telling users that they cannot firmly grasp live electrical
wires. "Grasping live electrical wires can result in unexpected results."



Rob Domaschuk | 312.853.8337 (o)
Technical Writer | 866.741.2677 (f)
Datalogics, inc. | www.datalogics.com

"What contemptible scoundrel stole the cork from my lunch?"
- W.C. Fields



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

ROBOHELP X5 - ALL NEW VERSION. Now with Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more!

Now is the best time to buy - special end of month promos, including:
$100 mail-in rebate; Free online orientation on content management
functionality; Huge savings on support and future product releases;
PLUS Great discounts on RoboHelp training. OFFER EXPIRES April 30th!
Call 1-800-358-9370 or visit: http://www.ehelp.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- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Previous by Author: RE: Why should a tech writer learn XML?
Next by Author: RE: Don't say what you CANNOT do in documents
Previous by Thread: RE: Don't say what you CANNOT do in documents
Next by Thread: RE: Don't say what you CANNOT do in documents


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


Sponsored Ads