Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Manage device versions and changes

A device in MSI has one or more versions, such as the release you submitted and the one you're developing now. Each version keeps its own knowledge, and MSI records every change to it, so you can see exactly what your documentation said at any point, compare two points, and start a new version from any of them.

Before you begin

  • Select the device. See Find your way around MSI.

  • Anyone who can see the device can view its versions and history. To create, edit or branch versions, your organization's plan must include Maturity Assessment.

Understand what a version holds

Each version has its own:

  • Architecture register, diagrams and security registers

  • Knowledge base and requirements

  • Attached documents

  • Settings: Lifecycle (R&D, Premarket, Postmarket or End of Life), Compliance Goal (the regulatory pathway), Device Modification Status and Risk Formula

The version selector in the page header, beside the device, sets which version you're working on. Whatever you view or create on a device page, such as a threat model or audit, is for the selected version. One version is the device's default; device-wide summaries use it.

Open the Versions tab

  1. In the sidebar, select Device Knowledge.

  2. Select the Versions group, then the Versions tab.

The table lists each version with its Lifecycle, Compliance Goal, Mod. Status, Risk formula and the version it was Branched from. The default version is marked default.

From a version's row you can:

  • Open it to make it the version you're viewing.

  • Edit its label and settings, then select Save.

  • Set default to make it the device's default version.

  • Change its lifecycle state directly from the Lifecycle badge.

Change history at the bottom of the tab lists changes to the selected version's settings, with who made each one and when.

Create a new version

Branch a new version when you start work on a new release. The new version starts with a copy of the source version's knowledge, then changes independently. The source version isn't affected.

  1. On the Versions tab, select Branch new version to branch from the version you're viewing, or select Branch on any row.

  2. Enter a New version label. It must be unique for this device.

  3. Choose the Lifecycle state.

  4. Optionally add Notes. They're recorded in the audit log.

  5. Check the Compliance Goal, Device Modification Status and Risk Formula.

  6. Select Create branch.

MSI opens the new version. While its knowledge is being built, the version selector shows Building….

Track changes over time

The Change tracking tab shows every recorded change to the device's knowledge across its versions, newest first. Changes come from documents being read, architecture runs, analyses and edits made by people.

  1. Select the Versions group, then the Change tracking tab.

  2. Choose Graph to see versions drawn as branches, or Table to see each change with its Version, who made it (By), When and What changed.

  3. To jump to a named milestone, use Go to a tag….

  4. If the list ends before the point you need, select Load older changes.

New changes appear a short time after they're made. A version's history starts with its first snapshot.

View the device at a point in time

  1. On the Change tracking tab, select a change.

  2. A banner shows Viewing version as of date and time — read-only. Switch between Architecture, Knowledge base, Entities & claims, Documents, Device records and What changed.

  3. Select Back to history to return to the list, or Back to live to return to the current version.

To see the history of a single architecture element, open the element on the Architecture tab and select View history.

Compare two points

  1. On the Change tracking tab, select Compare on two changes.

  2. Select Compare in the toolbar that appears.

The comparison shows a Summary of what was added, removed and changed, by kind of knowledge. Comparing points far apart can take a few seconds. To compare one point with the change just before it, open the point and select Compare with parent.

Tag a milestone

Tag the point you submitted to FDA, or any other milestone you might need to return to.

  1. Open the point on the Change tracking tab.

  2. Select Tag this commit.

  3. Enter a Tag name (for example, "Submitted to FDA 2026-10-01") and, optionally, a Note such as a submission number.

  4. Select Add tag.

Create a version from a point in history

Use this to start a new version from exactly what your documentation said at an earlier point, such as a tagged submission. MSI never reverts an existing version.

  1. Open the point on the Change tracking tab.

  2. Select Create new version from this point.

  3. Enter a New version label and, optionally, Notes.

  4. Select Create version.

The new version starts with that point's register, diagrams, knowledge base and documents. Every existing version stays as it is.

Next steps

Last updated

Was this helpful?