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.
I don't want to edit it. I was wondering if
anybody has ever seen fit to put a big honkin'
asterisk beside it, and then explain it in
a footnote (much as I had to explain it to our
new Product Mangler).
Before she came along, I would have thought it
a non-issue, but as I say, she's not stupid;
she simply hadn't encountered this stuff before.
Because of that, she asked some questions (about
stuff that I must have had to learn at some point
in the dim and distant past). So, maybe some of
our customers (or the people who review sample
manuals to decide whether our product is something
they want to purchase) are in the same boat.
That's all.
Maybe my footnote could say "In case you wondered..."
/kevin
>-----Original Message-----
>From: SHIELDS,SUSAN (HP-FtCollins,ex1) [mailto:susan_shields2 -at- hp -dot- com]
>
>Kevin McLauchlan asked:
>>So, now I'm wondering if any of the rest of you ever
>>take it upon yourselves to explain/annotate such
>>boilerplate text in your user docs.
>
>Depends on who generated the boilerplate.
>
> * If it came from the government, I don't change it.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
TECH*COMM 2001 Conference, July 15-18 in Washington, DC
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com
---
You are currently subscribed to techwr-l as: archive -at- raycomm -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.