User Guide
Table of Contents
User Guide
Reviewing in the Topic Editor
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 leave a comment in the topic you're reviewing.
Suggesting an Addition or Change
While reviewing a topic, you can suggest a change to specific text.
Suggesting a Deletion
Highlight text that you want to suggest to be removed.
Accepting or Rejecting a Suggestion
Use the Review features to accept or reject a suggested change.
Replying to a Comment or Suggested Change 
Reply to suggestions and comments made by a reviewer.
Resolving a Comment or Suggestion
Once a comment or suggestion is accepted or rejected, you can resolve the suggestion so you and others know it's completed.
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.

section
Use the Review 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 following 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 leave a comment in the topic you’re reviewing.
  1. Open a topic in the Topic Editor . Topic Editor
  2. Select the text that you’re commenting on or place the cursor where you want the comment to display.
  3. Click Review -> Comment .

    Step Information

    Expected Result
    A comment box displays in the margin.
  4. In the Comment field, enter a comment.
  5. Click Save.
result

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

While reviewing a topic, you can suggest a change to specific text.
  1. Open a topic in the Topic Editor . Topic Editor
  2. Select the text that you’re suggesting additions to or place the cursor where the suggested addition should be inserted.
  3. Click Review -> Suggest addition or change of content .

    Step Information

    Expected Result
    A comment box displays in the margin.
  4. In the Proposed Change field, enter your suggestion.
  5. (Optional) In the Comment field, enter a comment.
  6. Click Save .
result

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

Highlight text that you want to suggest to be removed.
  1. Open a topic in the Topic Editor . Topic Editor
  2. Select the text to be deleted.
  3. Click Review -> Suggest Deletion .

    Step Information
  4. (Optional) In the Comment field, enter a comment.
  5. Click Save.
result

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.
  1. Open a topic that contains a suggestion of change or deletion in the Topic Editor .
  2. If the suggested change is not displayed, click on the highlighted text in the document to open the reviewer’s suggestion.

    Step Information

  3. To accept a suggested change, click Apply .

    Expected Result

    The change is applied to the document and recorded in the revision history. 

  4. To reject a suggested change, click Reject .

    Expected Result

    The change is rejected and no edit is made to the document. The rejected change is recorded in the revision history. 

  5. Click to archive the suggestion.
result

The suggestion is accepted or rejected and then archived.

Replying to a Comment or Suggested Change 

Reply to suggestions and comments made by a reviewer.
context

You’re reviewing a document and want to reply to a comment or suggested change.

  1. In the Topic Editor , open a topic that contains a suggested change or comment.
  2. If the comment or suggested change is not displayed, click on the highlighted text in the document to open the comment.
  3. Enter a reply below the other comment.

    Step Information

  4. Click
result

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 or Suggestion

Once a comment or suggestion is accepted or rejected, you can resolve the suggestion so you and others know it’s completed.
  1. In the Topic Editor , open a topic that contains a suggested change or comment.
  2. If the comment or suggested change is not displayed, click on the highlighted text to open the comment.

    Step Information
  3. (Optional) Enter a reply to the comment.
  4. Click Resolve to close the comment box.
result

The resolved comment is recorded as part of the permanent revision history.