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

Subject: RE: Use of "Please" and the Like in Documentation
From: "Al Geist" <al -dot- geist -at- geistassociates -dot- com>
To: "'Barbara Vega'" <BarbaraV -at- libertyims -dot- com>, "'TECHWR-L'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 5 Jun 2008 13:39:34 -0400

Hi Barbara,

"Please" is superfluous in your example. I try to stay away from words like
"please," "thank you," and "mother may I" in my technical writing. I would
rewrite the sentence:

"For additional information on underwater basket weaving in the third world,
see "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."


Al Geist
Technical Communicator, Help, Web Design, Video, Photography
Office/Msg: 802-872-9190
Cell: 802-578-3964
Website: www.geistassociates.com
See Also:
Fine Art Photography
Website: www.geistimages.com

"...I walked to work, quit my job, and kept walking. Better to be a pilgrim
without a destination, I figured, than to cross the wrong threshold each
day." (Sy Safransky)


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

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.


Follow-Ups:

References:
Re: Fun with Word: From: Nancy Allison
Re: Fun with Word: From: Edwin Skau
RE: Fun with Word: From: Pinkham, Jim
Re: Fun with Word: From: Geoff Lane
Saving frequently and making backups (was RE: Fun with Word: From: McLauchlan, Kevin
Use of "Please" and the Like in Documentation: From: Barbara Vega

Previous by Author: RE: What do you guys think of STCs new definition for technicalwriter?
Next by Author: RE: OT - Wording of Announcements
Previous by Thread: RE: Use of "Please" and the Like in Documentation
Next by Thread: Re: Use of "Please" and the Like in Documentation


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


Sponsored Ads