Procurement teams often treat a firmware or controller upgrade as a routine maintenance item, yet the version number itself carries disciplined meaning when a supplier follows a formal rule set. Before authorising a change on a connected machine, vision system, or robot cell, the owner should treat the version string, release notes, dependency list and rollback evidence as a single record set. This article explains how to structure that evidence so later audits, service calls and configuration reviews can reconstruct what changed and who owned each interface.
The Semantic Versioning specification defines a normal version as MAJOR.MINOR.PATCH, where a MAJOR increment signals backward-incompatible API changes, a MINOR increment signals backward-compatible added functionality, and a PATCH increment signals backward-compatible bug fixes (Semantic Versioning 2.0.0). For a smart-equipment buyer, that mapping turns a build label into a first filter: a MAJOR jump on a motion-control library is not the same review category as a PATCH fix to a logging module. The same source notes that version 0.y.z is initial development where anything may change, which matters when a pilot line runs pre-release firmware. It also states pre-release versions have lower precedence than the associated normal version, so a 2.0.0-rc.1 build should not be recorded as equivalent to 2.0.0 in a commissioning log.
A supplier may state that an update is "supported," but that sentence is not the same artefact as a written dependency list. Recommended documentation practice is to keep a small register naming each software component the equipment calls: the controller runtime, the communication stack, any vision or AI inference library, and the host-side driver. For each entry, record the installed version before the change and the target version after the change, using the exact MAJOR.MINOR.PATCH form. Do not rely on a verbal confirmation during a sales review; place the register in the asset file so procurement, maintenance and the integrator read the same table. This is a recommended internal practice, not a requirement created by the cited versioning specification itself, which governs how numbers are assigned rather than what a buyer must file.
Vendors frequently ship summaries that emphasise new features. The owner should copy or attach the release note and then annotate it with the change class implied by the version: incompatible API change, added feature, or bug fix. The specification's rule that a released version's contents must not be modified, with any change issued as a new version (Semantic Versioning 2.0.0), supports keeping a frozen copy of the note at install time. If a later build appears without a matching version increment, record that discrepancy as an observation rather than repairing the machine yourself. The goal is safe observation and recordkeeping.
When a cell combines a robot arm, a third-party camera and an in-house scheduling service, no single vendor owns every call path. Before the version change, write down which organisation is responsible for each dependency: equipment OEM, component supplier, internal IT, or contracted integrator. Recommended documentation practice is a single row per named component with owner, contact route and the evidence that owner will require if the update fails. This prevents the common gap where a camera firmware update is applied by one party while the robot controller that consumes its stream is another party's responsibility.
Rollback is not only a technical capability; it is a documented position. Keep the prior version string, the configuration snapshot used at that version, and the observed behaviour baseline such as cycle time, error counters or communication handshake status. A hypothetical example: suppose a conveyor vision node moves from 1.4.2 to 2.0.0 and the inspection API changes shape; the rollback record should show that 1.4.2 with the saved configuration restored the prior frame-processing behaviour in the buyer's own log. That description is a recommended documentation practice for the buyer's file, not a certified result and not a safety guarantee.
NIST produced software supply chain security guidance resources under Executive Order 14028, including criteria to evaluate software security and supplier security practices (Software Supply Chain Security Guidance | NIST). The existence of that guidance does not endorse our checklist, and an institutional source is not a promise that a given vendor meets it. Still, it gives procurement a reason to ask for the same artefact types: what the supplier's secure practices are, and what evidence demonstrates conformance. Record the answer in the asset file next to the dependency register, dated and attributed.
Combine the pieces into one pre-change packet: exact source and target versions, dependency register with owners, annotated release note, configuration snapshot, behaviour baseline and support contacts. Reviewers working from technical articles on this site can adapt the packet to their own form; teams tracking rollout timing may also keep a copy with their industry updates subscription file. The packet does not make the equipment safer by itself, and no clinical, legal or regulatory-compliance outcome is claimed. It simply gives the next engineer a precise starting point if behaviour differs after the version change, turning a vague "it updated" note into a queryable record.