PRODUCT-NAME X.Y.Z: Release Notes

TODO: For each release, copy this file and fill in the needed information. Make sure to use the product name and external release number, not internal information.

Product Release Information

Product: PRODUCT-NAME
Release Number: X.Y.Z
Release Date: YYYY-MM-DD
Customer Support: For more information or support, please visit our website or email us at support@COMPANY.com

Introduction

1-4 SENTENCE DESCRIPTION OF PRODUCT

This document contains the release notes for PRODUCT-NAME version X.Y.Z. The following sections describe the release in detail and provide late-breaking or other information that supplements the main documentation.

TODO: Consider using one of the following example paragraphs.

This is a developer release for internal evaluation only. Please report any issues via the internal issue tracker.

This is an early access release for evaluation and usage by select partners. It is a pre-release product and should not be relied upon for mission-critical tasks. Your feedback is important to us, please help us make this the best product possible.

This is an early access release for wide evaluation and usage. Your feedback is important to us, please help us make this the best product possible. It is a pre-release product and should not be relied upon for mission-critical tasks. Keep in mind that we are continuing to work on PRODUCT-NAME and things may change in the future.

This is the first full release of this product. See the product website for a complete description.

(WHEN X IN VERSION NUMBER CHANGES) This is a major release with many new features. Users of previous releases should check the "Version Compatibility" section below for instructions on how to use existing data with this new release.

(WHEN Y IN VERSION NUMBER CHANGES) This is an upgrade release with some significant enhancements. Users of previous releases are encouraged to upgrade.

(WHEN Z IN VERSION NUMBER CHANGES) This is a maintenance release that improves quality, reliability, and performance without adding significant new functionality. All users of previous X.Y releases should upgrade to this release.

(WHEN DEFECT CORRECTION CLOSES SIGNIFICANT SECURITY HOLES) This is a critical upgrade release that addresses recently discovered security holes. All users of previous X.Y releases should upgrade immediately to this release.

What's New?

TODO: Briefly list broad classes of user-visible enhancements. Or, note that nothing major has been added. Technical improvements should only be mentioned if this is a reusable software component that will be used to build larger products. Do not include issue numbers. Links to detailed information can be helpful.
  • Added new consumer community features such as ratings of products and reviews
  • Enhanced usability for frequent users by adding automatic login, and one-button checkout
  • (FOR REUSABLE COMPONENTS ONLY) Streamlined build and testing processes
  • (FOR REUSABLE COMPONENTS ONLY) Roughly doubled unit test coverage
  • Many improvements to the product's quality, reliability, ease of use, and performance. See "Recent Changes" below for details.

Installation and Upgrade Notes

TODO: Fill in these sections. The text here is only a sample. Some of these requirements may be derived from updated environmental requirements in the SRS.
Installation
See the installation instructions for full details. Please note that in this release, ...
IMPORTANT: You must completely uninstall any previous "developer release" or "early access" version of this product before installing this release.
Manifest
This release consists of the following items:
  • Release notes (this file)
  • Installation instructions / Quick-start guide
  • Product installer binary
  • User guide
  • Product source code and build instructions
Minimum System Requirements
System Processor:800MHz PROCESSOR-TYPE
System Memory:256MB
Free Disk Space:10MB
Operating System: Windows 2000, Windows XP, Mac OS X, Linux (kernel 2.4)
Networking:Internet access
Existing Software:
  • Standard e-mail client
  • Popular web browser (IE6, NN7)
  • COMPONENT-NAME
  • COMPONENT-NAME (Needed for OPTIONAL-FEATURE)
Version Compatibility
Files saved by earlier versions of this product may be used with this version. However, files saved in versions prior to W.Y.Z, must be updated by using UTILITY-NAME.

Recent Changes

TODO: Query your public and private issue tracking systems to produce a report of changes in this release. Include the issue number, type, and one-line summary. Include issues that were highlighted in the "What's New?" section above. You may revise one-line summaries in the issue tracker prior to generating the report, if you notice that they are incorrect. You may exclude or summarize changes that might expose proprietary information.
  • Defects fixed
    • 09823 Shopping cart cannot add same item twice
    • 09912 Product ratings off by one
    • 10923 Session times out too soon
    • 10924 Cannot mix taxable and non-taxable
  • Enhancements
    • 08237 Consumer product reviews
    • 08238 Automatic login
    • 08259 One-button checkout
    • 10202 Per-product shipping estimates

Known Problems and Workarounds

TODO: Query your public and private issue tracking systems to produce a report of defects discovered in this release, or in previous releases that are still not resolved. Include information on workarounds from the issues. Otherwise, same as above.
  • 07293 Cannot order more than 99 of any one item.
    • Workaround: Place multiple orders and request shipping discount.
  • 10509 Product quantity must be an integer.
    • Workaround: Define smaller pseudo-products in default bundles: e.g., a 10-pack of 1/10 gallons of product. Click here for detailed instructions.
  • 10589 Expired coupons produce misleading error message
  • 10944 Gift cards may be purchased with zero initial balance
TODO: Check for words of wisdom for additional advice on this template.
Company Proprietary
Copyright © 2003-2004 Method Labs. All rights reserved. License terms. Retain this copyright statement whenever this file is used as a template.