Re: Address this. . .

Subject: Re: Address this. . .
From: Marguerite Krupp <mkrupp128 -at- yahoo -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sun, 14 Mar 2010 13:51:33 -0700 (PDT)

Bill Swallow wrote:
> IMHO, release notes should focus on what IS in the release and not on
> what isn't.

Among the things that ARE in the release are the known bugs. Call 'em what you will ("Known Anomalies," "Caveats," and "Issues" are among my favorites), but they're there. I'm in the camp of those who believe that you save yourself, your users, and your support staff a lot of grief by simply listing the bugs, along with brief descriptions and workarounds, if any. No promises that you'll ever look at them again (because sometimes you won't), just a simple statement of the facts.
IME, users say that they're more  interested in what doesn't work than in what got fixed in a release, just so they can avoid the known problems. In most places I've worked users want to see the open bugs list before the closed bugs list.
Just $0.02 more. Ultimately, the old "Golden Rule" applies: "Whoever has the gold makes the rules."


Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial:

Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at:

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: Address this. . .: From: Tony Chung

Previous by Author: Surveying user opinion of online help and user manuals
Next by Author: RE: Followup: Starting over: was re:How do hiring companies view TW resumes?
Previous by Thread: Re: Address this. . .
Next by Thread: RE: Address this. . .

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

Sponsored Ads