Difference between revisions of "Template:ReleaseNote"

From Catglobe Wiki
Jump to: navigation, search
m
m
Line 25: Line 25:
 
''(This section should give an overview of the new features or enhancements that are included in this release along with the main reason or focus of the release (there should always be a reason for a release !)''  
 
''(This section should give an overview of the new features or enhancements that are included in this release along with the main reason or focus of the release (there should always be a reason for a release !)''  
  
''This section (along with the Changes in this release section) should enable the reader to make the decision on whether this upgrade is relevant and necessary for them. This is important as it can save the reader a lot of time.''  
+
''This section (along with the Changes in this release section) should enable the reader to make the decision on whether this upgrade is relevant and necessary for them. This is important as it can save the reader a lot of time.)''  
  
''Changes in this release <br>Information about the changes and corrections to problems in previous releases can be placed in this section. It can include the bugs that have been corrected and perhaps how they have been corrected. The level of detail and technical content can vary depending on what the product is, for example, a complicated middleware application that has multiple integration points would need a detailed description of each bug fixed including the Bug Number, Symptom, Cause and Correction detail items whereas a simple application such as an editor may list a summary of each correction. )''  
+
= Changes in this release =
 +
''(Information about the changes and corrections to problems in previous releases can be placed in this section. It can include the bugs that have been corrected and perhaps how they have been corrected. The level of detail and technical content can vary depending on what the product is, for example, a complicated middleware application that has multiple integration points would need a detailed description of each bug fixed including the Bug Number, Symptom, Cause and Correction detail items whereas a simple application such as an editor may list a summary of each correction. )''  
  
 
{{{whatsNew}}}
 
{{{whatsNew}}}
 +
 
= Outstanding issues  =
 
= Outstanding issues  =
  

Revision as of 08:26, 28 April 2010

System requirements

(The new release may require additional hardware and resources or perhaps new versions of required (or dependent) software that must be installed first. This section can include supported operating systems or hardware platforms.)

{{{systemRequirement}}}

Installation

(This section should contain notes on installing the product. It might simply point to a separate installation document if it is a lengthy process.)

{{{installation}}}

Upgrading

(Special notes on upgrading from a previous version should be included in a separate section. These may also need to include notes on upgrading an installation that is several versions old.

If the instructions are detailed and lengthy then this section might just point to a separate document.

Also special attention should be paid to data changes (such as database tables) or perhaps the File and Directory structure as these are things which may affect some advanced installations, for example, you might need to get a database administrator to allocate additional table space, etc.)

{{{upgrading}}}

Whats New

(This section should give an overview of the new features or enhancements that are included in this release along with the main reason or focus of the release (there should always be a reason for a release !)

This section (along with the Changes in this release section) should enable the reader to make the decision on whether this upgrade is relevant and necessary for them. This is important as it can save the reader a lot of time.)

Changes in this release

(Information about the changes and corrections to problems in previous releases can be placed in this section. It can include the bugs that have been corrected and perhaps how they have been corrected. The level of detail and technical content can vary depending on what the product is, for example, a complicated middleware application that has multiple integration points would need a detailed description of each bug fixed including the Bug Number, Symptom, Cause and Correction detail items whereas a simple application such as an editor may list a summary of each correction. )

{{{whatsNew}}}

Outstanding issues

(This section usually includes minor problems that have been found while testing and creating the release.)

{{{outstandingIssue}}}

Known limitations

(This section includes limitations of the product, for example, problems which occur on a specific platform.)

{{{knownLimitation}}}

Contact information

(This section is good for directing specific release oriented questions to desired area. Supply an email address of the person or organization responsible for creating the release. If there is a product web site which contains the latest news and documentation then supply a link to it here so that people can look to find late breaking news and information.)

{{{contactInformation}}}