Release Process - Internal Release Note Template

Internal Release Note Template

Product Name

Version X.X.X.X Release Notes

Release Date: mm/dd/yy

Special Upgrade / Install Instructions

  • Include information regarding upgrading additional BoldGroup products related to this product.

  • Include information about contacting IT or Professional Services for assistance updating products (Hosted versus On-premises).

  • Include information regarding the order of upgrading or changes to the upgrade process.

  • Include any important information the customer needs to know such as discontinued support of specific products or the need to download special files before the upgrade.


Examples:

Supported Environments

Version Support

  • Include information about the versions of the additional BoldGroup products related to this product that are supported with this product version.

Minimum System Requirements:

  • Include information about specific version requirements for Microsoft Products
    1. SQL Server version
    2. Microsoft .NET version
    3. Windows Server OS Version
    4. Windows Client OS Version

Features

  • Include all new features included in this release.
  • Include a title of the new feature or enhancement and the DevOps item number.
  • Include the product and description of the feature.
  • For larger features include a reference to other documentation regarding this feature included in BoldWiki

Format:
Title (DevOps #) (Release Stage)
Description

Example:

Enhancements

  • Include title of enhancement to existing feature and DevOps item
  • Include description of the enhancement

Format:
Title (DevOps #) (Release Stage)
Description

Example:

Bugs

  • Include a list of all bugs corrected in this release.
  • Include a title of the issue with the DevOps item number.
  • Include the product, an expanded description of the issue, and the solution.

Format:
Title [Support#] (DevOps #)
Product - Specific area of the product (optional on some products)
Issue - Describe the problem
Solution - Describe the fix

Example:

(OPTIONAL)Reference Chart (Legend)

Contains a chart of terms or abbreviations and their description.

Example:

Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted for approval.