RE: Use of "Please" and the Like in Documentation

["Ron Hearn" <RHearn -at- cucbc -dot- com>]

I receive drafts for editing and formatting that use "Please" before
asking the reader to look in another part of the document or contact us
for more information. I usually remove the "please" when the document is
a technical document. For marketing material, I feel the use of "please"
is more applicable.


Ron

-----Original Message-----
From: techwr-l-bounces+rhearn=cucbc -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+rhearn=cucbc -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Barbara Vega
Sent: Thursday, June 05, 2008 10:18 AM
To: TECHWR-L
Subject: Use of "Please" and the Like in Documentation

A poll (of sorts: How many of you use words like "Please" etc. in your
documentation. Example:

"For additional information on underwater basket weaving in the third
world, please refer to the topic "Sending Overstuffed Cotton/Coton
T-Shirts to the Brazilian Coral Reef."

Or 

"Please see Chapter 12 for additional information on underwater basket
weaving in the third world." 

 or 


"Please contact the Keystone Cop Help Desk at (555) 555-1212 between the
hours of 2:00 and 4:00 A.M., PST.  
-----------------------------------------
Versus


"For additional information on underwater basket weaving in the third
world, refer to the topic "Sending Overstuffed Cotton/Coton T-Shirts to
the Brazilian Coral Reef."

Or 

"See Chapter 12 for additional information on underwater basket weaving
in the third world." 

 or 


I would add--
"(You may) contact the Keystone Cop Help Desk at (555) 555-1212 between
the hours of 2:00 and 4:00 A.M., PST.

================================
I think documentation, particularly for software, should have an
authoritative tone. (Also, if it is to be localized, I think "please"
and the like could get in the way. OTOH, the opposite could be true for
some cultures.)

What are your thoughts?

Barbara Vega

  

"This message is for the named person's use only. It may contain
confidential, proprietary 
or legally privileged information. No confidentiality or privilege is
waived or lost by any 
mistransmission. If you receive this message in error, please
immediately delete it and all 
copies of it from your system, destroy any hard copies of it and notify
the sender. You must 
not, directly or indirectly, use, disclose, distribute, print, or copy
any part of this 
message if you are not the intended recipient.   
 
If you receive this communication in error, please notify us immediately
by telephone (collect) 
at (714) 751-6900 and return the original message to us at the above
listed address via electronic 
mail. We will reimburse you for telephone expenses involved. Thank you."

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

Scanning of this message and addition of this footer is performed by
SurfControl Email Filter 
software in conjunction with McAffee virus detection software.









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

Create HTML or Microsoft Word content and convert to Help file formats
or 
printed documentation. Features include support for Windows Vista & 2007

Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as RHearn -at- cucbc -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/rhearn%40cucbc.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.


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

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! 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.