RE: Is this too Offensive for a manual?

Subject: RE: Is this too Offensive for a manual?
From: "Lippincott, Rick" <Rick -dot- Lippincott -at- flir -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 19 Nov 2003 09:14:38 -0500

Claire asked:

>There are some phrases used in reference to the meter readers that make
me >balk at including them. For example:
>Arising from incompetent, lazy or crooked meter readers...
>...reward performance and punish incompetence.
>In some cases these comments are absolutely true and the cause of
>significant business losses that the software is used to control.

I'd balk at those, also. IMHO, they cross over the line from simply
documenting the product and into editorializing. There's a place for
editorializing, but a company's documentation isn't it.

To use an absurd hypothetical (at least I hope it is) example, a manual
for a chainsaw might include a warning for the operator to keep face and
hands away from the chain while at all times. It wouldn't be necessary
to explain that the warning was included because some bozo fired his up
and tried to stick it in his mouth because he thought it would be a good
way to floss his molars.

Take the comments out, they're inappropriate.

--Rick Lippincott
Billerica, MA



RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for
competitive pricing or download a trial at:

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 for more resources and info.

Previous by Author: RE: Jobs, wealth, and change -- more reasons for optimism
Next by Author: RE: What do tech writers do?
Previous by Thread: Re: Is this too Offensive for a manual?
Next by Thread: RE: Is this too Offensive for a manual?

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

Sponsored Ads