Re: Release Notes

Subject: Re: Release Notes
From: quills -at- airmail -dot- net
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 4 Jan 2002 11:21:19 -0600

I'm coming late to the party, so my two cents worth may already be moot.

Release notes depend upon the audience. I have written release notes for end users and for programmers. The content differs accordingly.

End users want to know more about what is different that affects operation. Programmers want to know more about what changed where, why it changed, and what system operation changed (including variable names processes, etc.).

This is a very pared down comparison but in general, I think it encapsulates the needs of the two different audiences.

If your end user is an installer, then they will want more technical information, much as a programmer will.


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?

Have you looked at the new content on TECHWR-L lately?
See 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 for more resources and info.

Re: Release Notes: From: Joan Goldstein

Previous by Author: Re: Anyone familiar with "aspforums"?
Next by Author: Re: FrameMaker installation
Previous by Thread: Re: Release Notes
Next by Thread: Re: Release Notes

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

Sponsored Ads