Requirements Revisions Management

Almware automatically keeps a record of all changes made to requirement artifacts. Every time something is changed, Almware logs the event with details about what was modified.

Besides the event log, which shows changes for most artifacts in Almware, there is a special system for keeping track of different versions (revisions) of requirement artifacts. This system creates and assigns version numbers to major versions of the artifact automatically.

Event Log

Whenever someone changes a requirement artifact, those changes are recorded in the event log for that artifact. The log keeps a detailed record of all changes, showing what was different before and after the change. This makes sure there is a clear history of changes, so users can see who made what changes and when they were made.

The event log notes all small changes but does not create separate versions (revisions) for each small change.

Revisions

Almware has a revision system to highlight key versions of requirement artifacts and test cases.

A revision is a saved version of a artifact created when the artifact is closed (by pressing the "Close Artifact" button). Here’s how it works:

• A new revision is made when you start editing an artifact (the first revision is automatically made when you first create the document).
• Once you close the artifact, the revision is locked, and the artifact cannot be changed.
• To make further edits to the artifact, the user needs to open it for changes, which creates a new revision.

What a Revision Includes

Revisions save not just the main details of the artifact but also its references to related artifacts. It keeps a record of related artifacts at lower levels too.

Revisions also note the version of any related artifacts at the time of the revision.

Additionally, revisions save any files attached to the artifact, including diagrams. Diagrams created within Almware are saved with the revision, so when you look at past revisions, you will see the diagrams as they were when the document was closed.

Reverting to a Previous Revision

Users can change the current version of a artifact back to an earlier revision. When they do this, the current version is saved, and a new version is created based on the earlier revision.

Comparing Revisions

Users can compare the current version of a document with any of its earlier versions to see what has changed.