Creating requirement document snapshots

A snapshot is a version of a requirement document captured at a specific point in time. Snapshots are used for comparing document versions and viewing differences between them.

Snapshots are typically created in conjunction with project milestones. For example, you may create a snapshot when the first draft of a document is complete. If you need to refer to the original document version later, you can view the differences between the snapshot and a newer version to see what changed.

When you create a snapshot, current versions of all requirements included in the document are saved in the snapshot. If a requirement in a snapshot changes, the old requirement is versioned and archived. See Viewing historical requirement versions.

After you create a snapshot, you can compare it to the current document version or another snapshot to view the differences. See Viewing all changes between requirement document snapshots.

Administrators or other high-level users can configure triggers and escalation rules to automatically create snapshots. See Adding Create Snapshot automation rule actions.

1. Select a document in the Requirement Documents list window. You can also select the document in the requirements tree when you are viewing a document.

You can also create snapshots from the Snapshots tab when you are viewing or editing document details. See Viewing requirement document snapshots.

2. Choose Activities > Create Snapshot.

The Create Snapshot dialog box opens.

3. Enter a Label to summarize the purpose of the snapshot or project milestone it corresponds to.

4. Enter a Comment to explain why you are creating the snapshot.

To insert a stamp in the Comment field, click the Insert Stamp button. A stamp usually includes your name and the current date, but the format your team uses may be different. See Inserting stamps in text fields.

5. Click Create Snapshot.

The snapshot is created.

You can view snapshots from the Snapshots tab on the Edit Requirement Document or View Requirement Document dialog box. See Viewing requirement document snapshots. Snapshots are read-only and cannot be edited or deleted. They are only deleted when you delete a document.