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.
I hate to say this but your PM is off his/her rocker. Release notes are to
tell your customer about bug fixes, new feature that are NEW to the release
and also for information on know bugs (caveats) that may prevent your
customers from performing certain tasks. Here is what I cover in each set
of release notes that I write.
"These release notes support version XXX of NOCpulse Command
Center. They are updated as needed and include the following information:
Introduction
New Features
Minor Enhancements and Bug Fixes
Caveats and Known Issues
Service and Support
System Requirements
This is a maintenance and upgrade release of NOCpulse Command Center. A
summary of features and detailed functional procedures can be found in the
online user guide in the Help Center."
Wade
> -----Original Message-----
> From: Gavin Ireland [mailto:gavin -dot- ireland -at- sharpowl -dot- com]
> Sent: Monday, September 24, 2001 1:01 AM
> To: TECHWR-L
> Subject: Release Notes
>
>
> Does anyone have or know of an 'official?' definition of what
> release notes
> are or what they should contain?
> I'm asking 'cos I have a project manager insisting that I must include
> details of new functionality which doesn't exist and isn't
> likely to for a
> while. I think that this should be a marketing document.
>
> Gav Ireland MISTC
> Technical Author
>
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.comhttp://www.miramo.com +++
---
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 http://www.raycomm.com/techwhirl/ for more resources and info.
