Using Article Versions in KBase

Using Article Versions in Knowledge base

Versioning helps to keep track of and manage multiple revisions applied to a KBase article. You can view different versions of an article, compare an older version, restore to a previous version, leave a note on a particular version and much more.

Benefits

  • Retrace the history of an article since the date and time it was first created until present. You can click on a major or minor version to see the changes made, who made them and when.
  • Compare any two versions of an article to view the changes it underwent. The differences between the versions are highlighted to fix inaccuracies if any.
  • Restore an older version of an article if need be. It effectively means one thing: you can't mess up! The old version when restored will create a new one, making it the latest version.
  • Add notes to existing versions of an article. It can be a change you have made in that version or merely an alert to other agents.

How do versions work?

Any time you change the content of an article – a new version is created. If you just view an article or update their properties (like Title, SEO information, etc.) – the new version is not created, it is only created when you actually change something in the content editor.

What are 2 types of versioning?

You can have both minor and major versions on an article. Both the versions are identified numerically wherein unique numbers are assigned in increasing order. For example, version 0.1 is used to denote the initial draft or the minor version of an article. A major version is numbered by increasing the first part of the version number, e.g., 1.0. Subsequent minor versions are numbered 1.1, 1.2, 1.3, and so on.

Minor Versions
Minor versions are created when you save a draft of an article. There is no limit on the number of minor versions you can save except that it makes the user interface more complicated.

They are highly useful when:
  • The current article (major version) is published and available online.
  • You need to review and update the article or want to propose a change while the published document is still the official one.
  • This reviewed, updated or changed article version is added to the Drafts folder and kept invisible to the end users until it has been published as the new official article.

Major Versions
Major versions are created when you publish an article. If an article requires approval, it remains as a draft until the reviewer publishes it and assigns it a major version. Please note that only the published or the major version of the an article is accessible for your end users in the Help Center.

How to view version history?

You can keep track of all of the edits that were made in an article under the Versions tab.
To see the versions in an article:
  1. Click the Knowledge Base (KB) module.
  2. Navigate to the article for which you want to see version history.
  3. Click the Edit icon (  ) in the top menu bar.
    The article editor opens.
  4. Click Versions at the top of the right panel.
    You can view all the versions created for the article along with their respective owners and the time stamp.


How to add a version note?

You can add a short description to an article's version to help you remember the changes you’ve made to it.
To add a note to a version:
  1. Click the Knowledge Base (KB) module.
  2. Navigate to the article in which you want to add a note.
  3. Click the Edit icon (  ) in the top menu bar.
    The article editor opens.
  4. Click Versions at the top of the right panel.
    You will see the minor and major versions if available.
  5. Click on the version for which you want to add a note.
  6. Click +Add Note link corresponding to it and then enter the description.
  7. Click Add.
The description you've entered will be displayed on hovering the version. You may click the Edit link to modify the note.

Note:
  • You can't delete a note that's left on a version.
  • The note cannot exceed the maximum length of 250 characters. 

How to compare versions?

You can compare two specific versions of an article to view what has changed between the versions. It is especially helpful when several people work together on articles, or when information goes through several stages of drafts and review. Please keep in mind that you can compare only the contents of two article and not their properties like Title, SEO information etc.
To compare two versions:
  1. Click the Knowledge Base (KB) module.
  2. Navigate to the article in which you want to compare versions.
  3. Click the Edit icon (  ) in the top menu bar.
    The article editor opens.
  4. Click Versions at the top of the right panel.
    You will see the minor and major versions if available.
  5. Click Compare link at the top of the versions panel.
  6. Check the boxes next to the versions you would like to compare. You can select a maximum of 2 versions.
  7. Click Compare at the bottom of the versions panel.
  8. On the next screen, you will see the results of the comparison.
When you compare versions, Zoho Desk displays the two versions side-by-side — the most recent one on the left and the version that you are comparing it with on the right side of the window. The two versions scroll synchronously so that you can see the changes in context. You can also click the Expand icon (  ) to view the comparison panes on a larger window.

Note:
  • You cannot edit the versions while you are comparing them.

How to restore a version?

You can review different versions of your article and restore to an earlier version if required. 
To restore to an earlier version:
  1. Click the Knowledge Base (KB) module.
  2. Navigate to the article in which you want to restore a version.
  3. Click the Edit icon (  ) in the top menu bar.
    The article editor opens.
  4. Click Versions at the top of the right panel.
    You will see the minor and major versions if available.
  5. Review the versions that are listed and select the one to be restored.
  6. Click Restore this version at the top of the versions panel.
    Note: Quick Edit is displayed for the version that is available online.
    The contents from your restored version will be loaded into your editor.
  7. Click Publish.

Using quick edit in articles

The quick edit option is displayed when an article is already published and there is also a draft version of it. It allows the users to edit the main version or the published article without modifying the draft.

For example, if John is editing a published article, it will be autosaved as a draft unless he publishes it. In the meantime, if Adam has to make some urgent modifications to the published article, he can use the quick edit option to work on the main article directly and publish it without altering the draft that John has been working on.  



The Quick Edit icon (  ) is displayed right next to the Edit option. The option is available only for articles that are Published under the My Articles view.
After clicking Quick Edit, the user is shown an alert message that another user is already working on a draft of the article. They can click Continue to proceed with editing the published article. 

For example, in the image below, Adam is being alerted that the article he is going to edit is already being modified by John. Adam can click Continue to edit and publish the main article without having an impact on John's draft. 


Note: The changes made using Quick Edit can only be published immediately and cannot be saved as a draft. 

Comparing the edited versions

Users who have permission to edit an article will receive a notification that edits are being made to the article.

Within the notification, there is a Compare button, which users can click to compare the changes made with the existing published article.
Text that has been removed is marked in red, text that has been added is marked in green and text that has been modified will be marked in blue.

Before John publishes his new draft, he will see a pop-up notification that there was a recent quick edit made by Adam. This allows John to review the current version of the article and compare the changes before publishing.


Note
  1. If two agents update the same text in both the edit and quick edit mode, those changes will not be highlighted in the comparison mode. 
  2. If two agents are adding content in edit mode and saving the article as a draft, the saved changes can be viewed by both agents when they revisit it.

    Zoho CRM Training Programs

    Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

    Zoho CRM Training
      Redefine the way you work
      with Zoho Workplace

        Zoho DataPrep Personalized Demo

        If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

        Zoho CRM Training

          Create, share, and deliver

          beautiful slides from anywhere.

          Get Started Now


            Zoho Sign now offers specialized one-on-one training for both administrators and developers.

            BOOK A SESSION











                                        You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                            Manage your brands on social media

                                              Zoho Desk Resources

                                              • Desk Community Learning Series


                                              • Digest


                                              • Functions


                                              • Meetups


                                              • Kbase


                                              • Resources


                                              • Glossary


                                              • Desk Marketplace


                                              • MVP Corner


                                              • Word of the Day


                                                Zoho Marketing Automation

                                                  Zoho Sheet Resources

                                                   

                                                      Zoho Forms Resources


                                                        Secure your business
                                                        communication with Zoho Mail


                                                        Mail on the move with
                                                        Zoho Mail mobile application

                                                          Stay on top of your schedule
                                                          at all times


                                                          Carry your calendar with you
                                                          Anytime, anywhere




                                                                Zoho Sign Resources

                                                                  Sign, Paperless!

                                                                  Sign and send business documents on the go!

                                                                  Get Started Now




                                                                          Zoho TeamInbox Resources



                                                                                  Zoho DataPrep Resources



                                                                                    Zoho DataPrep Demo

                                                                                    Get a personalized demo or POC

                                                                                    REGISTER NOW


                                                                                      Design. Discuss. Deliver.

                                                                                      Create visually engaging stories with Zoho Show.

                                                                                      Get Started Now









                                                                                                          • Related Articles

                                                                                                          • Knowledge Base Article Views

                                                                                                            The Knowledge Base (KB) module in the Zoho Desk is the information center that acts as a self-service repository for your customers. Customers can refer to the articles in the KB and solve product-related issues on their own. Knowledge base profile ...
                                                                                                          • Adding, Editing, Cloning, Unpublishing, and Deleting Knowledge Base Articles

                                                                                                            The Knowledge Base (KB) is a self-serve online library of information that enables your customers to access solution articles for addressing various product or service-related queries. You can create articles related to your product or service and ...
                                                                                                          • Viewing Article History in Knowledge base

                                                                                                            Generally, knowledge base articles undergo multiple updates both during the drafting and publishing stages. Sometimes it might become an overwhelming task to keep track of all the edits and know what is going on around an article. Keeping track of ...
                                                                                                          • Allowing Public Comments on Knowledge Base Articles

                                                                                                            Customer feedback plays an important role in improving products, as well as the instructional resources associated with them. With more organizations implementing self-service customer support models, it's imperative to give customers an opportunity ...
                                                                                                          • Organizing your Knowledge Base Content

                                                                                                            One of the simplest and most overlooked aspects of being organized is getting your knowledge base articles in order. You have to think about where to put your articles so that your customers can easily locate them, so you must begin with the ...
                                                                                                            Wherever you are is as good as
                                                                                                            your workplace

                                                                                                              Resources

                                                                                                              Videos

                                                                                                              Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                              eBooks

                                                                                                              Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                              Webinars

                                                                                                              Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                              CRM Tips

                                                                                                              Make the most of Zoho CRM with these useful tips.



                                                                                                                Zoho Show Resources