Table of Contents
User Guide
Reviewing
Reviewing Overview
The Topic Editor includes Review features that enable reviewers to insert comments and suggest edits to topics.
Adding a Comment 
Use the Review menu in the Topic Editor to enter a comment.
Suggesting an Addition or Change
Use the Review menu in the Topic Editor to suggest content be added or changed.  
Suggesting a Deletion
Use the Review menu in the Topic Editor to suggest content be deleted.  
Accepting or Rejecting a Suggestion
Use the Review features to accept or reject a suggested change.
Replying to a Comment or Suggested Change 
Use the Review features to reply to a comment or a suggested change.
Resolving a Comment
Use the Review features to resolve a comment.
Reviewing Overview

The Topic Editor includes Review features that enable reviewers to insert comments and suggest edits to topics.
When reviewing a topic, you can insert comments or suggest edits to the owner of the document without affecting the original text. Your suggestions will only take affect if the document owner accepts them.
Use the Review drop-down menu in the toolbar to insert comments or suggest edits.
Comments and suggestions display in the margin of the document. An icon also displays inline to indicate there is a comment or suggestion in the document.
The text associated to the comment or suggestion is highlighted in the follow colors:
  • Comments – Yellow
  • Suggest addition or change of content – Blue
  • Suggest Deletion – Red
Adding a Comment 

Use the Review menu in the Topic Editor to enter a comment.
You’re reviewing a document and want to leave a comment.
  1. Select the text that you’re commenting on or place the cursor where you want the comment to display.
  2. Click Review -> Comment.

    Step Information

    Expected Result
    A comment box displays in the margin.
  3. In the Comment field, enter a comment.
  4. Click Save.
Your comment is recorded and visible to other users. An icon displays inline to indicate there is a comment, and the selected text is highlighted in yellow. An inbox notification is also sent to the document owner.
Suggesting an Addition or Change

Use the Review menu in the Topic Editor to suggest content be added or changed.  
You’re reviewing a document and want to suggest content be added or changed. 
  1. Select the text that you’re suggesting additions to or place the cursor where the suggested addition should be inserted.
  2. Click Review -> Suggest addition or change of content.

    Step Information
    Expected Result
    A comment box displays in the margin.
  3. In the Proposed Change field, enter your suggestion.
  4. (Optional) In the Comment field, enter a comment.
  5. Click Save.
The suggested addition or change is recorded. An icon displays inline to indicate there is a suggestion, and the selected text is highlighted in blue.
Suggesting a Deletion

Use the Review menu in the Topic Editor to suggest content be deleted.  
You’re reviewing a topic and want to suggest content be deleted. 
  1. Select the text to be deleted.
  2. Click the Review -> Suggest Deletion.

    Step Information
  3. (Optional) In the Comment field, enter a comment.
  4. Click Save.
The suggested deletion is recorded. An icon displays inline to indicate there is a suggestion, and the selected text is highlighted in red.
Accepting or Rejecting a Suggestion

Use the Review features to accept or reject a suggested change.
You’re a contributor or author of a document and want to accept or reject changes suggested by a reviewer. 
  1. If the suggested change is not displayed, click on the highlighted text in the document to open the reviewer’s suggestion.

    Step Information

  2. To accept a suggested change, click Apply Change.

    Expected Result

    The change is accepted, the suggested change pop up is closed and no longer visible, the edit is made to the document, and the change is recorded in the revision history. 

  3. To reject a suggested change, click Reject..

    Expected Result

    The change is rejected, the suggested change pop up is closed and no longer visible. No edit is made to the document, and the rejected change is recorded in the revision history. 

The suggestion is accepted or rejected.
Replying to a Comment or Suggested Change 

Use the Review features to reply to a comment or a suggested change.
You’re reviewing a document and want to reply to a comment or suggestion change.
  1. If the comment or suggested change is not displayed, click on the highlighted text in the document to open the comment.
  2. Enter a reply below the other comment.

    Step Information

  3. Click Save
Your comment is recorded and visible to others. An inbox notification is also sent to the document owner as well as the user you replied to.
Resolving a Comment

Use the Review features to resolve a comment.
You’re a contributor or author of a document and want to resolve a comment.
  1. If the comment is not displayed, click on the highlighted text to open the comment.

    Step Information
  2. (Optional) Enter a reply to the comment.
  3. Click Resolve to close the comment box.
The resolved comment is recorded as part of the permanent revision history.