Contributing to a review

Track your contributions

The dashboard of a project allows you to find the reviews in which you have been invited to contribute and the status of your contribution. For more details, see the section Consulting a dashboard.

Contributing to a review objective

A review is broken down into review objectives. The creator of the review assigned you some review objectives and indicated the main resource to review. For more details, see the section Creating and tracking a review.

As a contributor to a review objective, you are prompted to browse through the different resources of each review objective. You can comment textually or graphically on these resources.

You can mark the resource review as complete:

A confirmation can be displayed to confirm a resource reviewing is complete before marking it as reviewed. See the Project administration section of the administration guide for more information.

The page of the review updates your progress as resources are marked as reviews.

Add a comment

You must be a contributor to a review to create comments. When you visit an element of a project, you can contribute to it by commenting it via the current review (s) "Ongoing".

Contribution to a review can be done in several ways:

In the case of an added comment for a diagram, it is possible to reference the related areas on the diagram. These references can be updated by clicking the link Modify in the comment.

If you are part of at least one group in the project, you can optionally restrict the visibility of your discussion to a group's members.
You can later make this discussion public by removing the group restriction.

Adding graphical annotations

In the case of a diagram, you can associate a comment with graphical annotations:

  1. In the Comments tab, select the comment to which you want to associate a graphical annotation.
  2. Then click on the Annotate link at the bottom of the comment or the button Annotate in the diagram toolbar.
  3. Add graphical annotations with the toolbar above the diagram.
  4. Click the Finish annotation link at the bottom of the comment or the corresponding button in the diagram toolbar.

The following tools are available for annotating a diagram:

ToolAction
Zoom-In
Zoom-Out
Back to Full-Size 100%
Activate/Deactivate the Annotation Mode
Select all the annotations
Delete the graphical annotation
Add a note
Add a comment
Design a rectangle
Design a circle
Design a line

To create a graphical annotation, you can:

Via the contextual menu of a graphical annotation, it is possible to modify the colors (text, line, and background) and line thicknesses of the figure.

By selecting a figure, it is possible to resize it (square hook points) or to connect it to another figure (round hook points).

Annotation anchor points

Editing a comment

The author of a comment can modify its content.

Removing a comment

The author of a comment can edit his comments and delete a comment to which no one has replied.

Remark: The author of a comment can edit his comments and delete a comment to which no one has replied.

Closing / reopening a discussion

The creator of an initial comment or the project leader can close or reopen a thread.
When closing a discussion, you can add a comment to explain the reasons for closing a comment.

Dealing with third party comments

You can share the review's public comments with third parties that happen have the original models by exporting them to Excel. Third parties can review the comments from the Excel file, reply up to 5 times, then send it back to you for import on your SECollab. This import will create all replies that the third party has put in the Excel sheet. New comments will be created with the importer as author, and will contain a mention of the original author in their description.

This feature can't delete any existing comment, nor can it start a new conversation by creating a new root comment.
It will only ever create replies on existing comments.

Findings

When a discussion has brought to light some problem or evolution, this can be tracked by creating a finding. The project leader can create findings, and track them in the review details screen. Findings can be linked to a related change request in the external change management system to track the changes that must be accounted for.

Findings have 3 states to help you track your work's status: not started, in progress, and closed.

They can also be deleted in case of an erroneous creation.

When creating findings from the Finalize review screen, the project leader can link it to resources considered suspect. This makes it easy to identify which resources are impacted by each finding.

Comment label

Comments labels allow you to uniquely identify the elements of a discussion (comments and findings).
They are easily readable by a human being because they result from the concatenation of the key of the review in which they are created and a unique number that is incremented with each creation of a discussion element.
Comment labels are agnostic to the configuration in which they are created.

Finalizing the review

When working on the review, the project leader benefits from the finalize review screen, a 3 panel screen comprised of:

Note that a dynamic review objective titled "Other commented resources" is added at the end of the tree. It contains all commented resources that are not already part of a review objective.

This screen offers a complete and detailed overview of commented resources and gives the project leader easy access to closing discussions, creating findings, with potentially suspect resources. Closing the review is still done in the review details screen.