Using Guide

When you create a new article, you can preview how the article will appear in your help center, both before and after saving.

When editing a published article, you can preview either the edits you are making on the published version of the article.

To preview edits to published articles

1. In your help center, open an article in edit mode.
2. Add or edit content.
3. Click the arrow next to the Preview button to select one of the following options:
   • Published article - Last published version of the article. This opens the version that is live in your help center.
   • Preview - Current saved or unsaved version of the published article that you are editing. This version opens in a new tab in Preview mode and displays the changes you have made to the article.

   

4. To make and preview additional edits, leave the Preview tab open and do the following:
   • Return to the article editor and add or update content.
   • Click the Preview tab to return to the Preview mode.
   • Refresh the browser page to display the new edits or additions.

   When you're ready, you can save and publish the article. See Creating and editing articles in the knowledge base.

Guide admins can create new articles. Agents can create new articles if they have management permissions. Agent privileges for new articles vary depending on their management permissions. See the complete list of agent privileges for existing, published articles.

You can create a maximum of 40,000 total articles, excluding translations. This limit includes articles in all states, except archived.

To add an article to the knowledge base

1. In your help center or Guide, click Add in the top menu bar, then select Article.

   

2. Enter your content.
   • Use the article editor's toolbar for formatting options or to add links, images, or tables. This toolbar is not the same as the toolbar in community posts.

     

     For information, see the Help center article editor toolbar reference. See also Inserting links, Inserting images in articles and content blocks, and Inserting videos. For tables, check out this formatting tip.

   • Edit the HTML source by clicking the Source Code button at the end of the editor's toolbar.

     Note: To keep your help center secure and provide the best experience for your end users, Zendesk limits the HTML you can use in articles. For information, see Allowing unsafe HTML in articles.
3. Review and configure the article settings in the Management section:
   • Under Management permissions, click the drop-down arrow, then select management permissions to determine which agents have editing and publishing rights for this article.
     • Administrators enables only Guide admins to edit and publish the article. This option is selected by default on new articles.
     • Agents and admins enables all agents and admins to edit and publish the article.
     • Editors and Publishers (Enterprise plans only), enables all agents and admins to edit this article but only admins can publish the article. This option appears only if it's been activated.
     • Custom management permission enables specific user segments to edit and publish the article.

     Depending on your account, you might also see an agents and managers option.

     Guide admins can apply any management permissions. Agents with management permissions can apply only the management permissions they belong to. Agents who do not have management permissions on any article will not see this option, and the management permissions will default to admins.

   • Under Owner, verify or select a new owner for the article.
4. Review and configure the article settings in the Placement section:
   • Under Section, click Manage sections, then select a new section and click Ok.

     You can search for or navigate to the section. All of your categories might not appear in the window. To navigate, click the expander arrows to drill down to the section you want.

     

   • Under Author, verify or select a new author for the article.
   • Under Viewing permissions, select one of the following options to determine which users can view this article:
     • Visible to everyone includes anyone who visits your help center and does not require sign in.
     • Only visible to selected user segments select up to 10 user segments from any of the following:
       • Signed-in users includes internal and external users who create an account and sign in to your help center.
       • Agents and admins includes team members only, so that you can create content that is internal-only.
         Note: Light agents are included in this segment. For a list of light agent permissions, see Understanding and setting light agent permissions.
       • Custom user segment enables you to restrict viewing access to specific users based on tags, organizations, or groups by applying user segments. See Creating user segments to restrict access.
   • (Not available on Suite Team) Under Content tags, start typing the content tag you want to add, then select Add as new tag or select the matching content tag, if it exists. See Adding content tags to articles.
   • (Not available on Suite Team) Under Labels, add any labels you want.

     As you start typing, a list of existing labels appears for you to chose from, or you can add a new keyword by selecting Add as a new label or by typing a word and pressing Enter.

     

     For more information about using labels and best practices, see Using labels on help center articles.

     You can add labels to the default language article only and not to translations of the article. You can add labels in multiple languages to the default article.

   • Choose any of the following options:
     • To close the article for comments, deselect Turn on comments.
     • To promote the article in its section, select Promote article.
     • To add an attachment, click Manage attachment in the Attachments section at the bottom of the pane. See Attaching media to articles.

       The file size limit is 20 MB. You can remove an attachment by clicking the x next to it.

   • (Enterprise plans only) Under Template, if you have multiple article templates in your live theme, click the drop-down, then select a template.

     You might have to scroll down to see this option. If you do not select an alternate template, the default article template will be applied.

     

   • Under Attached media, click Manage attached media to attach a downloadable file to the article. See Attaching media to articles.
5. When you are finished working on your article, do one of the following:
   • To save your new article as a draft or work in progress to publish later, click Save.

     Click Preview to view the article in your help center.

   • When you're ready to publish your article, click the drop-down arrow on the Save button, then select Publish.

Guide admins can edit any articles. Agents can edit existing articles where they have management permissions. Agent privileges for existing articles vary depending on their management permissions. See the complete list of agent privileges for existing, published articles.

Saving edits for an existing published article as a work in progress is only available on Guide Enterprise.

There are some article updates that you can make on multiple articles in bulk. For more information, see Updating knowledge base articles in bulk.