Creation and follow-up of a review

A user with the appropriate role can create a review and add reviewers among project members. Creating a review is done by clicking on the New Review button on the page listing the reviews of the project. A review can be also created from a template. To achieve this, click the toggle icon right of the "New Review" button then click "From review template".

A review has a title, key, description, priority [High / Medium / Low], due date, as well as objectives.

When creating a review from a template, the title and description of the review and its objectives are preset from the template's values.

Definition of contributors

Once the review has been created, you can list the contributors who will participate in the review:

  1. On the Review page General tab, click the Edit button in the Contributors area.
  2. Select from among the members of the project those who can contribute to the review.

Defining the scope of the review

You can then list the designs affected by the review. Reducing the review to a certain list of designs helps to clarify the perimeter of the review. This will facilitate the selection of resources for review in the review elements (see below). This will also alleviate the Resource Comments box, where only the relevant reviews will be displayed.

Here are the steps to narrow down the list of designs:

  1. On the review page General tab, click the Edit button in the Designs area.
  2. Select from the project designs those whose resources can be commented on as part of the review.

Defining the objectives of the review

A review is broken down into review objectives. Each review objective is summarized by a title and a description.

Here are the steps to add a review objective:

  1. On the review page Objectives tab, click the Add button.
  2. On the General tab of the authoring window, give a title and description to the review objective. This information should tell a contributor what actions you expect from them.
  3. On the Resources tab, select the primary resources affected by this review objective. The selectable resources are those contained in the designs referenced by the review, or the designs themselves.
  4. On the Contributors tab, select the subset of contributors affected by this review objective. Not all review contributors are necessarily involved in each review objective. Reducing the number of contributors to this level makes it possible to assign to each contributor an objective according to their area of competence.

The review objectives can be reordered with the Sort button in the Review Objectives tab.

Monitoring of the review and life cycle

A review has a fixed workflow: [Creation of the review] => Not started => [Start the review] => In Progress => [Finalize the review] => Completed.

Once the review objectives are created, you can start the review by clicking the Start Review button on the toolbar. Contributors can then begin their review work and comment on design resources.

The review page details its progress:

The Comments tab on the review page displays all of the comments created by contributors in this review. Comments can be filtered by design, resource, review objective, type, status, creator and custom attributes. Custom attributes that appear on the table can be configured by a user with the appropriate role.

Once the contributors have completed their review, you can close the review by clicking the Close Review button on the toolbar. The review can then be re-opened, if necessary, via the same button.

Generation of a report on the review

Via the Report, button, a report document can be produced on the current review. For more information, see the section Generating a report.

Delete Review

A Delete drop-down menu is available on the review page for users with the appropriate permission. It permanently erases the review AND the comments created as part of this review.

Caution: As deletion is definitive, it is recommended that you use this feature only in rare cases.