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.
Bill Swallow wrote:
> IMHO, release notes should focus on what IS in the release and not on
> what isn't.
Yabbut...
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: http://www.doctohelp.com
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: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-