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.
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-