Re: Release Notes

Subject: Re: Release Notes
From: Joan Goldstein <gldstein -at- nortelnetworks -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 03 Jan 2002 17:48:05 -0500

Typically, my customers want to know:

What's new in the release
Limitations or restrictions of the product
Installation or upgrade issues (if not in the install guide)
What was fixed
What are the known problems (with workarounds, please).

And just for kicks, we add "documentation errors and omissions" for those items
we weren't able to get into our product manuals.

Release Notes can be anything from a text Read Me file to a book-like creature
with a ToC and cover page. It could even be divided into chapters (depending on
size and product complexity). I 've seen Release Notes ranging from 1 page to
500!

cheers,

Joan Goldstein
Nortel Networks

Ellen Vanrenen wrote:

> Hello everyone.
> My question of the day is about release notes. At this point in time, our
> release notes are merely a list of what has and has not been fixed in the
> newest version.
> What is the standard purpose of release notes? What do they generally look
> like? If I've ever received any release notes from any software I've
> purchased, I've never looked at them.
> I think our clients certainly pour over the release notes they get from us.
> Thanks again for your invaluable assistance.
>
> Ellen Vanrenen
> Technical Product Documentation Specialist
> Clear Technology, Inc.
>
> telephone: 303-583-4170 (direct line)
> email: ellen -dot- vanrenen -at- clear-technology -dot- com


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

---
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.


Follow-Ups:

Previous by Author: Re: Applying On-Line
Next by Author: Re: Online Help for a J2EE server-side application
Previous by Thread: Re: Release Notes
Next by Thread: Re: Release Notes


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


Sponsored Ads