Manage Requirements Changes

Documentation / Manage

ReqView records history of changes automatically for projects saved with the Save History option, see Save Projects.

You can view changes of the selected document object in the History Pane or browse project changes in the Project History View.

View Object History

Change Indicator

You can see icon in the ID column for all changed document objects not yet saved into the open Project File or Project Folder.

Filter Document Changes

To filter all changed document objects with a changed attribute, choose Changed from the filter suggestions list. Then optionally select a specific attribute or enter a start date. See Filter History.

History Pane

To view changes of the selected document object in the History pane, click View, select History Pane, or press CtrlAltH.

History Pane indicating changes in the document

Browse Project History

To browse changes of the current project in the Project History dialog, click Project and select History.

You can choose one of the following history views:

You can filter the current view to display only changes made during a given time or by a specific user. You can also export the current view into an HTML report.

Document Time View

  • Tabs separate changed documents
  • Table displays changes of the given document ordered by time
  • Rows represent consequent changes of the same document object
Display Document Time View with changes ordered by time

Document Structure View

  • Tabs separate changed documents
  • Table displays document tree hierarchy
  • Rows represent document objects; check Hide unchanged in the toolbar to hide rows with unchanged objects
Display Document Structure View with changes ordered by document tree hierarchy

Project Time View

  • Table displays changes from all documents ordered by time
  • Rows represent consequent changes of the same document object
Display Document Structure View with changes ordered by document tree hierarchy

Filter Project Changes

To filter the most recent changes, select the Last 7 days, Last 14 days, or Last 30 days. To filter changes made between specific dates, select Custom period and enter the dates in the From and To fields.

To filter changes done by a user, enter a keyword matching the user name in the Author field.

Export HTML Report

To export the current view into an HTML report, click button from the toolbar and select the output folder.

Export HTML report of the current project history view

Manage Projects in VCS

You can manage project versions under the Subversion Version Control System (VCS), see Collaborate via Subversion (SVN) and Subversion (SVN) Administration.

You can collaborate using a simple workflow:

We plan to extend this workflow by displaying a SVN log of project changes, creating an SVN tag for a project baseline, opening an SVN revision of the project in a separate window, and comparing the current project version with another SVN revision or a tag. At the moment, you can do these operations in an external SVN GUI client or from the command line, see Advanced SVN Operations.

Compare Project Baselines

You can compare a project with its previous version (baseline) saved as a Project File or Project Folder on your filesystem. If you manage a project under SVN version control system then check out its baseline into a new working copy on your filesystem.

To compare the project with a baseline, click Project, mouseover Compare Project, and select Compare File or Compare Folder.

The Compare Project dialog displays each changed document in Theirs and Mine side-by-side views:

Side-by-side comparison of two requirements projects versions
  • Left view (Theirs): highlights changes of the compared project version not matched in the change history of the current project version, e.g., permanently removed requirements since the baseline
  • Right view (Mine): highlights changes of the current project version not matched in the change history of the compared project version, e.g., updated requirements since the baseline.

By default, two columns are displayed in both the Theirs and Mine views:

  • ID — document object ID
  • Theirs to Mine / Mine — the text description followed by the summary of changes

To display additional columns, click icon.

To iterate over document changes, use the following toolbar buttons:

  • — move to the first change
  • — move to the previous change
  • — move to the next change
  • — move to the last change

To refresh the Mine view with changes done in another window, click icon.

To switch between Diff Theirs to Mine and Diff Theirs to Base modes, click icon. This is useful when your project history has diverged. For example, assume you opened file A, did some work on it and saved it as file B. Then you opened file A again and did further work, which you saved as file C. Using this example, the two panes of the Diff Their to Mine mode would compare files B and C, while the Diff Theirs to Base mode would compare B to A in the left pane and C to A in the right pane.

To print the current view or save it to a PDF, click icon.

To return from the Compare Project dialog, click icon.

Control Project Changes

You can follow a simple workflow for controlling project changes based on requirements comments and status attribute:

  1. Propose Changes
  2. Review Change Proposals
  3. Approve Requirements

You can define custom enumeration attribute status with values: Draft, Ready, Reviewed, Approved, and Released, see Requirement Status. You can display and update status values in the Status column.

You can display and update requirement comments in the Discussion pane. To display the Discussion pane, click View, mouseover Right Panes, and select Discussion Pane, or press CtrlAltD.

Discussion pane

Propose Changes

You can create new requirements as described in Create New Objects. Set status of new requirements to Draft.

To add a new comment proposing a change to an existing requirement, click Edit and select Add Comment. You can also press CtrlD or click in the toolbar.

To update a change proposal, click above the corresponding comment in the Discussion pane.

Edit Comment dialog

If a changed requirement is ready for review then set its status to Ready.

Review Change Proposals

To filter all requirements with status attribute set to Ready, enter Status: Ready in the filter input field. See Filter Enumeration Values.

If a requirement change is clarified, update the requirement as proposed, and set the requirement status to Reviewed.

After you update a requirement as agreed you might want to delete change proposal comments in the Discussion pane. To delete a comment, click above the comment and then click Delete in the Edit Comment dialog. You can find deleted comments in the History Pane later.

Approve Requirements

To filter all requirements with status attribute set to Reviewed, enter Status: Reviewed in the filter input field. See Filter Enumeration Values. To approve a changed requirement, set its status to Approved.

Example: Define the attribute status as described in Requirement Status. Display Status column in the table view. Select two requirements and set their status to Approved.

Use custom attribute to approve requirement changes.

Analyze Impact of Changes

You can conveniently analyze impact of high-level requirement changes by displaying requirements coverage across multiple levels in an Impact Analysis View or Impact Analysis Report.

Impact Analysis View

Use the Traceability Column Wizard to add new custom traceability columns into the Traceability Matrix view easily. Or, create advanced Template Columns with a custom template code.

Example: Create a template column Downstream Traceability displaying for each top-level business need (NEEDS) the related SW requirements (SRS) and test cases (TESTS), and a warning if satisfaction or verification traceability links are missing.

Downstream Traceability Coverage referencing tests, indicating missing verification links

Impact Analysis Report

If you need to export the impact analysis to an external document export the current traceability view to DOCX, XLSX, PDF, CSV, or other text formats. You can also create a traceability report with custom layout and styling.

Example: Create a traceability report displaying top-level business needs (NEEDS) in the left columns ID and Description and the related SW requirements (SRS) and test cases (TESTS) in the right Traceability column:

Requirement Traceability Report: requirements, traceability information, and test statuses

If the customer wants to change a user story (NEEDS-24) then you can immediately see in this report which implemented SW requirements (SRS-58 and SRS-60) and test cases (TESTS-22) needs to be updated.

Similarly, you can create an inverse bottom-up traceability report to reveal SW requirements not connected to any user need which indicates that these features were not possibly requested by the customer (gold-plating).

Download full example traceability report templates from the ReqView Support Site > Download Example Traceability Templates (login is required).

A common requirements management challenge is tracking changes in linked objects. You can propagate changes of high-level requirements downstream by maintaining suspect flag for traceability links.

Let’s assume that our software development project stores high-level user stories in a NEEDS document, SW requirements in a SRS document, and that SRS requirements are linked by satisfaction links to the corresponding high-level NEEDS. See also the Example Project.

How can be the author of the SRS document be informed about changes in the NEEDS document to keep the SRS document updated?

If you enable tracking suspect flags for satisfaction links then a change of a user story in the NEEDS document will set the suspect flag for all its incoming satisfaction links.

The author of the SRS document is notified about the change by an suspect flag indicator displayed in all linked SW requirements. He can review the change, update the linked SW requirements, end finally clear the link suspect flags to be notified about future changes.

You can enable tracking of suspect flags for a traceability link type by its suspect property in the Project Traceability dialog, see Link Type Definition. Set the value of the suspect property for a the link type to an array of suspect attributes. A link becomes suspect if any of the suspect attributes of its target object changes.

Permitted suspect attributes are: heading, text, deleted, attachments and custom attribute IDs.

Example: Configure the suspect property for satisfaction links to track heading, text and deleted suspect attributes:

{
"satisfaction": {
"name": "Satisfaction",
"source": "Satisfies",
"target": "Is satisfied by",
"suspect": ["heading", "text", "deleted"]
}
}

Suspect link flags are displayed as icons in the Links column or pane.

Example: Change user story NEEDS-58. You will be notified about the upstream change by icon when the row with the linked software requirement SRS-62 is displayed:

Notification about upstream changes by suspect link flags displayed in the Links column

To filter all document objects with an outgoing suspect link, choose Suspect and then <link type> from the filter suggestion list, see Filter Links.

Clear Suspect Flags

To clear a suspect link flag, right-click a link in the Links column or pane and select Clear Suspect Link Flag from the context menu:

Clear Suspect Link Flag contex menu

The suspect link flag icon for the cleared link will disappear. It will show again after you change the link target object again.

To clear suspect flag of all outgoing links of selected document objects, click Edit and select Clear Suspect Flag, or press CtrlJ.

Updated for version 2.14.0