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.
Subject:Release Considerations: the followup From:"hope.d.cascio" <hope -dot- d -dot- cascio -at- ARTHURANDERSEN -dot- COM> Date:Mon, 9 Feb 1998 11:07:09 -0600
On 5 February, I posted:
Do you, or have you, included release considerations as a separate file in
software you've written for, and if so, which types of considerations did you
include: new features, known bugs, bugs fixed since the last release? Please
respond off list if you think this could get out of hand on the list, and I'll
compile a consensus to post in a few days. Thanks.
Thank you to everyone who responded. The results I've received, in a nutshell:
* Of those who mentioned the delivery format, 3 used readme.txt-type files and
1 used WinHelp
* New features is the most universally included section
* Name varies, but usually something like Release Notes. Had one comment that
"considerations" sounded a lot friendlier (sorta like calling bug fixes
enhancements!)
* Most included bug fixes and known bugs. In one case, it was dependent on how
serious they were, in another, they were only available to clients so potential
clients wouldn't be "scared off", and in a third, only dealers had access to
known bugs/fixes.
* Only one specifically said that software/hardware requirements were included
* Other items included were differences between how the program operates and
how the documentation describes its operation, conversion and installation
issues,
FWIW, we deliver Release Considerations as an uncompressed Help file with new
features, known bugs, and conversion issues broken down by module of the
program. Installation instructions are sent hardcopy. We've also recently
begun including bug fixes from the previous release.
Hope Cascio, Knowledge Transfer Developer
Arthur Andersen Technology Solutions
