KB User's Guide - Minor vs Major Document Changes

When publishing a change to an existing KB document, the change will be marked as either "major" or "minor". This document describes how this designation is determined, as well as the effects of publishing a major change.

Note: Currently, "minor" and "major" changes are determined by on the "Minor change" checkbox under the "Additional Fields" section of the doc edit screen. This is being phased out in favor of the process described below on March 11, 2021.

How Minor and Major Changes are Calculated

Whether or not a published change is designated as "minor" or "major" will depend on what percentage of the content has changed since the last time the document was published. This percentage is calculated based on the words in the key content fields—title, summary, body, and internal notes.

Because the keywords field does not directly relate to the primary document content, it is excluded from the calculation. In addition, HTML tags themselves are ignored. For this reason, the insertion, modification, or deletion of supplementary content like images and hyperlinks will not be counted, nor will styling changes.

When you save a document as In Progress or In Review, you will see a "Content change since the last save" percentage displayed on the submission confirmation screen. It will also be logged in the Comments and Events history for the document. 

Example image of a content change since the last save message reporting 37%

When you publish a document, you will also see a "Content change compared to the last active version" percentage displayed, in addition to the percentage change since the last save. Both values will be logged in the Comments and Events history.

Example image of a content change compared to the last active version message reporting 41%

By default, a published change that constitutes over 20% of the document content will be flagged as a major change. This threshold can be adjusted for individual KB group spaces by a site admin by doing the following:

  1. Open the SitePref tab and go to the Group Spaces page.
  2. Click the Edit button for your group space.
  3. Select the desired percentage from the Default change threshold: dropdown
  4. Click Update to save your changes.

Effects of a Major Change

A published change being flagged as "major" has two key effects:

  1. If the document is currently shared with one or more other group spaces, a major change will temporarily take the document down and move it back to In Review for those spaces. They will then need to review and republish the document.
  2. Any users that have subscribed to changes for that document will receive an automated email notification alerting them to the change. For more information on subscribing to changes, please see: KB User's Guide - General Info - Subscribe to Changes