Working with Requirements

You can view a requirement specification or a requirement and create comments, annotations, and other markers on its content.

Before you begin: Open a requirement specification or a requirement.
Note: You can have only one requirement specification or one requirement as a context for a markup.
  1. From the Validation section of the action bar, click Review .
    A review is created for the requirement specification or the requirement loaded in the widget.
    Note: If the Automatically create a first markup preference is selected, a review markup feature is also created. For more information, see Table 1.
  2. Optional: Click Review Markup .
    A markup feature is created and a markup is added in the comments panel on the right side of the 3D area.
  3. Click Comment to add a comment.

    • You can also create a comment by clicking + in the comments panel or using commands available in the context toolbar.
    • You can create comments linked to the selected text, marker, or a selected point or position of the requirement specification.

    The comment is displayed in the comments panel. If the comment is linked to the text, it is highlighted in the color assigned to the creator of the comment.
    Notes:
    • You can click next to the comment to post a reply to the comment.
    • When you delete a comment, you can also choose to delete the markers associated with it by selecting the Delete markers associated with selected commands in the message box.
    • You can manually save the markup, whenever you edit a comment. To do so, click the spinner in the upper-right corner of the work area.
    • When the widget width is smaller than 550 pixels, the panel is automatically hidden in the following cases:
      • After selecting a comment in the comments panel
      • While adding a new comment using New Comment +
      • After validating the comment
      • While activating or deactivating the markup
  4. Click next to the comment to post a reply to the comment.

    • You can delete a selected reply using the contextual command.
    • If you click next to a reply, it creates another reply to the parent comment.

    The replies are displayed under the parent comment in the comments panel.
  5. To create a highlight linked to a comment, select a comment and do one of the following:
    • From the Validation section of the action bar, click Create Highlight .
    • Under Highlights in the review panel, click Add Highlight .

    Notes:
    • You can also create the highlight first and then link it to a comment.
    • If the comment content is modified, the comment representation under the highlight is also modified.
    • In the comments panel, if a comment is linked to a highlight, a highlight icon () is displayed in the comment box.

    A highlight linked to the selected comment is created. The comment is also displayed in the thumbnail of the highlight in the review panel. You can use the Hide Preview or Show Preview options from the context menu, to hide or show the full preview of the comments linked to the highlights.
  6. Create freehand, circle, rectangle, and arrow markers to highlight parts of the requirement specification.

    Notes:
    • You can edit and move these markers using the transformation handles.
    • You can create markers only within the boundaries of the page.
    • You can manually save the markup whenever you edit the graphic properties or the position of the marker. To do so, click the spinner in the upper-right corner of the work area.

  7. Click one of the following commands to browse through the comments in the requirement specification:
    • Previous Comment : Navigates you to the previous comment in the comments panel.
    • Next Comment : Navigates you to the next comment in the comments panel.
    • < and > options in the comments panel to navigate to the previous and the next comment respectively.

    Notes:
    • The comments panel is not visible in the presentation mode.
    • If the comment is created on a missing requirement element, a warning icon is displayed next to the comment, in the comments panel.
    • For a review containing multiple markups, If you clock Next Comment from the last comment of the currently selected markup, the first comment in the next marker containing a comment is displayed. The comments navigation is cyclic. Therefore if you navigate to the next comment from the last comment of the last markup, the first markup is set as current and the first comment under this markup is displayed.

  8. From the View section of the action bar, click one of the following commands to move to a previous or the next page:
    • Previous Page : to display the previous requirement.
    • Next Page : to display the next requirement.
  9. Optional: Click the hyperlink on the page to open it.
    • If the hyperlink points to an external URL, it opens in a new tab.
    • If the hyperlink points to a position in the context, the pointed position is displayed.
  10. Optional: Click Bookmarks Panel .
    A panel displaying all the chapters, sub-chapters, requirements under the requirement specification, and comments on the requirements in a tree structure. Click to see all the sub-elements.

    The Bookmarks Panel command is only available for requirement specifications.

    Note: By default, The bookmark panel is displayed.

    Note: When the widget width is smaller than 550 pixels, the panel is automatically hidden when you activate a bookmark in the Bookmarks Panel.
  11. Optional: Click Presentation Mode .
    The presentation mode lets you browse through the comments and elements in the loaded requirement or requirement specification.
    Note: When you hover over any text or markup element associated with a comment, the comment is displayed.