Quality Management:Quality manual/Work instructions/Release Note: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
The release note below is used in all projects governed by [http://vteam.dk Virtual Team A/S (Danish)] [http://www.virtualteam.biz/en/about/partners (English)]. | |||
==Release Note== | ==Release Note== | ||
All software releases must have a release note. The format below may be used. The release note must at least have the following informations stated: | All software releases must have a release note. The format below may be used. The release note must at least have the following informations stated: | ||
* Project name | * Date | ||
* Project name / Product name | |||
* Date of release | * Date of release | ||
* Name of responsible release engineer | * Name of responsible release engineer | ||
* Release category: Describe the target for the release e.g.: | * Release category: Describe the target for the release e.g.: Bi-weekly development, Alpha, Beta, Production, Error correction]. | ||
* Changes in release: with references to development requirements and/or bug trace references. | * Changes in release: with references to development requirements and/or bug trace references. | ||
* Dependencies: E.g. if special database version is needed or special configuration is needed. | * Dependencies: E.g. if special database version is needed or special configuration is needed. | ||
* Test requirements: Information about what tests has been executed and what remains | * Test requirements: Information about what tests has been executed and what remains. Reference to test documentation. Requirements to test environment. | ||
* Known issues. | * Known issues. | ||
* Target for next release: Reference to development requirements and/or bug trace references. | * Target for next release: Reference to development requirements and/or bug trace references. | ||
Further information that is also useful: | |||
* Reason for the change / release | |||
* Analysis of consequences: E.g. for the target organization. Needed update of documentation. | |||
Example of release note are shown below: | |||
<syntaxhighlight lang="text"> | <syntaxhighlight lang="text"> | ||
File: releasenote.txt | File: releasenote.txt | ||
| Line 24: | Line 28: | ||
================================================================================ | ================================================================================ | ||
Date: <date> | Date: <date> | ||
Release category: | Release category: [Options: Bi-weekly development, Alpha, Beta, Production, Error correction] | ||
Release engineer: <Name> | Release engineer: <Name> | ||
================================================================================ | ================================================================================ | ||
| Line 46: | Line 50: | ||
END of note. | END of note. | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==References== | |||
* [http://pmis.biz/downloads/Release_Note_version_01(da).doc Release_Note_version_01(da).doc - Release note in danish] | |||
==Document History== | ==Document History== | ||
| Line 67: | Line 74: | ||
| Final | | Final | ||
| Text review and minor corrections | | Text review and minor corrections | ||
|- | |||
| 3 | |||
| 31 May 2012 | |||
| PSA | |||
| Final | |||
| Text revised and danish release note added | |||
|- | |- | ||
| | | | ||
Latest revision as of 14:19, 31 May 2012
The release note below is used in all projects governed by Virtual Team A/S (Danish) (English).
Release Note
All software releases must have a release note. The format below may be used. The release note must at least have the following informations stated:
- Date
- Project name / Product name
- Date of release
- Name of responsible release engineer
- Release category: Describe the target for the release e.g.: Bi-weekly development, Alpha, Beta, Production, Error correction].
- Changes in release: with references to development requirements and/or bug trace references.
- Dependencies: E.g. if special database version is needed or special configuration is needed.
- Test requirements: Information about what tests has been executed and what remains. Reference to test documentation. Requirements to test environment.
- Known issues.
- Target for next release: Reference to development requirements and/or bug trace references.
Further information that is also useful:
- Reason for the change / release
- Analysis of consequences: E.g. for the target organization. Needed update of documentation.
Example of release note are shown below:
File: releasenote.txt
QA ref.: http://pmis.biz/wiki/QM:Quality_manual/Work_instructions/Release_Note
RELEASE NOTE - <project name> project
================================================================================
Date: <date>
Release category: [Options: Bi-weekly development, Alpha, Beta, Production, Error correction]
Release engineer: <Name>
================================================================================
Changes in this release:
<Reference> <Short description>
================================================================================
Dependencies:
================================================================================
Test requirements:
================================================================================
Known issues:
Target for next release:
================================================================================
END of note.References
Document History
| Version | Date | Author | Status | Purpose of update |
|---|---|---|---|---|
| 1 | 25 Aug 2011 | PSA | Draft | New document |
| 2 | 13 Jan 2012 | PSA | Final | Text review and minor corrections |
| 3 | 31 May 2012 | PSA | Final | Text revised and danish release note added |