RE: Release notes

["Jessica Weissman" <Jessica -dot- Weissman -at- hillcrestlabs -dot- com>]

I can't speak to readme files since we try very hard not to have them -
the release notes are revised up until the just before the release is
approved and the disks cut, so they keep up with changes.

We have a standard template including a TOC and title page, mostly
because our releases are targeted to a small set of customers and need
to be formal.  Sections include:

Introduction
	Release Description (a general overview of what the release is
and how it relates to other products)
	Release Components (an annotated list with version numbers since
component version numbers can differ from the overall release version
number)
Release Notes
	System Requirements
	What's New (a brief rundown of any new features)
	Changes in this release (annotated list of changes, with page
references to the product documentation where relevant or available)
	Installation Process (a summary and a reference to the install
doc or where the instructions are on the install disks)
	Upgrade Notes (Information relevant to upgraders.  So far this
has been information on whether to uninstall first and how to handle any
old data)
	Outstanding Issues (a list of issues from the bug tracking
system that are still open, with workarounds)

Hope this helps.

Jessica Weissman
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.