ReadySetGit/Words-of-Wisdom-Release-Notes.md

44 lines
1.4 KiB
Markdown
Raw Normal View History

2021-08-02 15:24:06 +00:00
# Release Notes
2021-08-02 17:30:16 +00:00
## Line-by-line Instructions
### Release Number
2021-08-02 15:24:06 +00:00
This is the external release number (the one that customers see).
2021-08-02 17:30:16 +00:00
### Release Date
2021-08-02 15:24:06 +00:00
Note the date of the official release.
2021-08-02 17:30:16 +00:00
### Customer Support
2021-08-02 15:24:06 +00:00
Give clear contact information in the release notes.
2021-08-02 17:30:16 +00:00
### Introduction
2021-08-02 15:24:06 +00:00
Briefly describe the product and the type of release. Letting customers know the type of release is an important way to set expections and gather needed feedback from early releases.
2021-08-02 17:30:16 +00:00
### What's New?
2021-08-02 15:24:06 +00:00
Briefly list the most important new features or user-visible changes. Each item in this list should be a potential reason for an existing customer to upgrade to this release.
2021-08-02 17:30:16 +00:00
### Installation and Upgrade Notes
2021-08-02 15:24:06 +00:00
Link to the installation instructions. Include any urgent warnings here.
2021-08-02 17:30:16 +00:00
### Minimum System Requirements
2021-08-02 15:24:06 +00:00
List the minimal system resources needed to run the system. This information can be derived from the SRS environmental requirements.
2021-08-02 17:30:16 +00:00
### Version Compatibility
2021-08-02 15:24:06 +00:00
Include this section if there are important things that users must know about the compatability of files produced by previous releases.
2021-08-02 17:30:16 +00:00
### Recent Changes
2021-08-02 15:24:06 +00:00
This is a more detailed list of changes in this release. These items can usually be copied from a report generated in your issue tracking tool.
2021-08-02 17:30:16 +00:00
### Known Problems and Workarounds
2021-08-02 15:24:06 +00:00
Include a list of known problems and workarounds. These are problems that are already tracked in your issue tracking tool, but that have not been resolved in this release.