Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 1.5 KB

index.md

File metadata and controls

48 lines (34 loc) · 1.5 KB
Raw

Release notes

Release notes describe and list the changes of a software version and are normally published to the user and customer of a application or app.

Learn about creating and managing release notes at https://indoc.pro/documentation-types/release-notes/

Elements of a release note

  • Software version (optional release & build number), and/or the release date
  • Added public features
  • Fixed public bugs
  • Known issues

Additional information can be added if available or necessary, as e.g.

  • Download link
  • Supported platforms and environments
  • Prerequisites
  • Removed features
  • Installation & upgrade instructions

Release notes template

The release notes template is described in this external file Release notes template for easy copying.

Release notes example

The following section provides an example of a release note.

indoc Documentation Release 1.0

Version 1.0.0, from 2022-01-06

Changes

  • Initialized first public release
  • Changed Version to 1.0.0

New features

  • Initial content for documentation types "how-to guide" and "release note"

Fixed bugs

  • No bugs have been fixed

Download

You can always download the latest release at https://github.com/indocPro

Supported platforms and environments

No specific restrictions.

Installation & upgrade instructions

In case, you forked the github repository, you can pull the latest updates into your repository/branch. Otherwise copy and overwrite your local files, or merge the changes manually.