Re: Wording problem! Arrrggh!

Subject: Re: Wording problem! Arrrggh!
From: Gene Kim-Eng <techwr -at- genek -dot- com>
To: Stuart Burnfield <slb -at- westnet -dot- com -dot- au>
Date: Fri, 10 Jun 2011 08:31:28 -0700

Most of my writing experience over the years has been for big-ticket users
who are not bashful about reporting issues with the systems they buy. They
expect to see release notes for new builds specifically state that an issue
they reported against the previous build has been resolved and list known
issues that have not been resolved yet. I've seen customers write purchase
orders for new products that specify the new purchase is not to be delivered
or billed for until unresolved issues with their existing products have been
cleared. I've also documented a lot of products for regulated markets,
where approvals are often conditional and specify that products may not be
used in certain applications where known issues exist until those issues
have been resolved, and where regulators often assume that a product
submission that has no known issues must mean the submitter is not testing
thoroughly or is leaving something out. In these environments we sell "new
features" and the phrase "improved" is almost never used, because it usually
just tells the readers we didn't get it right the last time.

Gene Kim-Eng

Marguerite said:
> > Most places I've worked would NEVER admit to fixing a problem
> > (because that would imply that their software was buggy to begin
> > with!), but they would let us say that we'd made an improvement.
> > So we could say, for example, "improved system response time...",
> > but not, "fixed a problem where system crashed...."

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.

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

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

Please move off-topic discussions to the Chat list, at:

Re: Wording problem! Arrrggh!: From: Stuart Burnfield

Previous by Author: Re: Problem with Visio cross functional diagrams
Next by Author: Re: Web-based docs and help (from JavaHelp perhaps?)
Previous by Thread: Re: Wording problem! Arrrggh!
Next by Thread: Sample description of alternative technology

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

Sponsored Ads