Topics Map > Documents Tab

KB User's Guide - Documents Tab - Editing When Review Comments Are Required

This document describes the steps authors need to take when their KB group requires review comments to edit documents.

Some KB admins may opt to require that authors in their group enter a comment before making changes to published documents. Doing so can help improve the usefulness of the document activity log, as comments there will ideally give an indication of what changes were being made at a given point in time.

If comments are required in your group space, a modal will appear when you select the Edit button for a document that is currently only published (i.e. it is not in dual status). You will be expected to briefly describe the changes you are about to make in the Comment field. Examples of useful comments include:

  • "Updating screenshots to match latest UI changes"
  • "Adding troubleshooting information for 404 errors"
  • "Updating link to vendor website"

If desired, you can check the box to Cc: the document owner and/or admin, which will send your comment in an email to the selected recipient(s).

Example of a modal titled Comment for Document 153970. The modal text reads "This group requires a comment before editing a published document."

Upon clicking Submit, the comment will be recorded in the document activity log, and the edit screen will open. If you start making changes and save them in a Draft version, you will not need to enter comments the next time you return to resume editing.

For information on enabling this setting, please see KB User's Guide - Settings Tab - Requiring Review Comments.

See Also