Skip to main content

Student record - Data Futures

Back to Student

Version control

Version 1.0.0 Produced 2018-03-07

This document outlines the process of assigning either unique version names or unique version numbers to unique states of documentation. Version control enables us to tell one version of a document from another.

Version numbering

The version numbering specification adopted by HESA follows a sequence-based versioning scheme. Under this scheme, version numbers and the way they change convey the significance of changes between releases: changes are classified by significance level, and the decision of which sequence to change between releases is based on the significance of the changes, whereby the first sequence is changed for the most significant changes, and changes to sequences after the first represent changes of decreasing significance.

A normal version number must take the form X.Y.Z where X, Y, and Z are non-negative integers, and must not contain leading zeroes. X is the major version, Y is the minor version, and Z is the patch version. Each element must increase numerically.

Once versioned documentation has been released, the contents of that version must not be modified. Any modifications must be released as a new version.

A major version (X.y.z) must be incremented when any changes are made that will have a significant impact on the backwards compatibility of documentation. It may also include minor and patch level changes. Both the minor and patch version must be reset to 0 when a major version is incremented. These would often be fundamental changes that significantly affect the XSD (XML Schema Definition).

A minor version (x.Y.z) must be incremented when any changes are introduced to the documentation that impact on the backwards compatibility of documentation. It may also include patch level changes. The patch version must be reset to 0 when a minor version is incremented. These would often be changes that affect the XSD (XML Schema Definition). Examples include changes to: Data model location; Data types; Field lengths; Primary and Foreign keys; Valid entries and labels.

A patch version (x.y.Z) must be incremented if only backwards compatible changes are introduced to the documentation. These would be changes that have no effect the XSD (XML Schema Definition). Examples include changes to: Description; Coverage; Notes; Reason required.

Revision notes

When incrementing the version number of a document an accompanying revision note must be produced. The revision note should be clear and concise, explaining to the user exactly what has changed and why.


Need help?

Contact Liaison by email or on 01242 211144.