Version numbers for physical hardware, such as a PCB, and documentation, such as a user guide, follow the rules below.
The version number format is:
<major number> . <minor number> . <revision number>
where each ‘number’ is a single digit from 0 to 9. For example: 1.2.3
The major version number only increments for a very significant change to a design or document.
The minor version number increments for each functional or layout change to a design or document. The minor version number resets to zero if the major version number changes.
The revision number increments for each published release of a document or physical hardware. Revisions are usually for corrections or cosmetic changes. The revision number resets to zero if either the major or minor version number changes.
Associating a document to a hardware version
Any document referring to a specific hardware release will have the same major and minor version number as the hardware it describes.
A revision number may not be the same for the document and the hardware, as the functionality only changes when the major or minor version number changes. Therefore, a cosmetic change to a PCB, such as adding a new note as part of the silkscreen, can be made without revising its schematic. This results in a common major and minor version number, but potentially non-matching revision numbers.
To ensure you have the correct documentation, check the major and minor version numbers are the same on the hardware and the document. For this purpose, ignore the revision numbers.
Some early designs do not include a revision number. In such cases, just read the version as if the revision number is zero.
Software and its documentation
Software and its documentation uses the same <major> . <minor> . <revision> numbering system. Again, the major and minor version numbers indicate which software release a specific document refers to.
An Example
At the time of writing, SC611 (RCBus Micro SD module) has had one ‘minor’ hardware revision.
The original release of the printed circuit board was version 1.0.0 and the latest documents for it are Kit Contents Sheet version 1.0.1 and Schematic version 1.0.0. A revision was made to the Kit Contents Sheet without the PCB or the Schematic being revised.
A later version of the PCB added a second connector for remote connection to a Micro SD card adapter. The PCB is currently version 1.1.0, with the Kit Contents Sheet at version 1.1.0 and the Schematic also at version 1.1.0. These version numbers indicate the second connector required a ‘minor’ version number change and each document was updated to match. Neither the PCB or any of its documents have needed further revision.
The SC611 product page includes all of the above files and describes the the difference between the ‘minor’ versions.
