Comments and Suggestions

Add comments and suggestions to documents to leave feedback on the content. Users can reply to one another in comments, which, in conjunction with archiving comments, enriches the audit trail.

You can leave comments and suggestions on a file using the following interfaces:

  • Review interface
  • topic editor
  • Content tab in the resource manager

The file owner receives inbox notifications about comments, which are visible in a user's Inbox interface. Other users can also see your comments and reply to them. When other users reply to your comments, you'll receive inbox notifications so that you can follow up on the comment.

Here's an example of a comment:

Add Comments

Use Editing , Suggesting or Commenting mode to leave a comment on a document. This enables you to select an entire element or highlight parts of an element to leave a comment on.
  1. Open a topic in the topic editor, Review interface, or resource manager.
  2. Highlight the text that you're commenting on or place the cursor where you want the comment to display.
  3. Click the comment icon that appears in the document or the icon in the text editing toolbar.
  4. In the Comment field, enter a comment.
    Tip: To mention a user in the comment, enter @ and select the user you want to mention in the comment. The user mentioned will receive an email notification and an easyDITA Inbox notification.
  5. Click Save.

Add Suggestions

Use Suggesting mode to add inline, tracked changes to a document.
You must be in Suggesting mode to add tracked changes.
  1. Open a topic in the topic editor, Review interface, or resource manager.
  2. Select the text that you want to change or delete, or place the cursor where the suggested addition should be inserted.
  3. Insert your suggestion.
  4. Optional: Enter a comment in the Comment field of the new comment in the Review tab and click Reply .

Reply to Suggestions or Comments

Use the Review tab to reply to tracked changes and comments from another user.

  1. In the topic editor, Review interface, or resource manager, open a topic that contains a tracked change or comment.
  2. Click on the tracked change or highlighted text in the document to open the Review tab, if it isn't already opened.
  3. Enter a reply in the Reply field.
  4. Click Reply .

Accept or Reject Suggestions

Use the Review tab to accept or reject a tracked change.

  1. In the topic editor, Review interface, or resource manager, open a topic that contains a tracked change or comment.
  2. Click on the highlighted text in the document to open the reviewer's suggestion in the Review tab.
  3. Click the checkmark to accept the change.
  4. Click the x to reject the change.

Resolve Comments

Resolve a tracked change or suggestion so you and others know it's completed.

  1. In the topic editor, Review interface, or resource manager, open a topic that contains a tracked change or comment.
  2. Click on the tracked change or highlighted text in the document to open the Review tab , if it isn't already opened.

  3. Optional: Enter a reply to the comment.
  4. Click Resolve to resolve the comment.
  5. Click Archive to save and archive the comment.

View Archived Comments

Use the Comments pane to view archived comments.

  1. In the topic editor, Review interface, or resource manager, open a topic that contains a tracked change or comment.
  2. Click the Review tab.
  3. Click Archived .