Write Knowledge Base Articles
Help articles answer the questions readers ask most. Each one has a title, a summary, a category, a body and its own address under /help.
| Menu | Content > Content Items |
| Permission | The content permissions of the Knowledge Article type (for example Edit Knowledge Article and Publish Knowledge Article) |
| Feature | Knowledge Base |
What you see depends on your role. If the menu, a button or a setting on this page is missing, ask your administrator to give you the permission listed above or to turn on the feature. Only administrators can turn features on and change site settings.
Write an article
- Go to Content > Content Items, select New, and choose Knowledge Article. To find the articles you wrote, filter the list by Knowledge Article.
- Give it a Title.
- In Which roles can see this content, pick who may open it. It reads Any role until you pick one, and then everyone can read it. Pick Authenticated for anyone who is signed in, or your staff roles for an article only your team should read.
- Write a short Summary: one or two sentences shown in lists, searches and suggestions. Search looks at the title and the summary.
- Choose its Category to list it with similar articles.
- Write the Body in the editor. Its toolbar formats text, adds links, lists, tables and pictures, and shows a preview.
- The Permalink is filled in from the title, under
help/, such ashelp/reset-your-password. Change it if you want another address. - Publish it, or save a draft to finish later.
Who can read an article
| Roles picked | Who sees the article |
|---|---|
| None (Any role) | Anyone, signed in or not |
| Authenticated | Anyone with an account who is signed in |
| Staff roles, such as Editor | People in one of those roles |
Administrators read every article. Which roles can see this content works as Restrict Content by Role does for any content, and holds everywhere the article shows: the help center, its search, related articles, suggestions and the article's own page. People outside the picked roles don't find the article, and get You do not have access to this resource. if they open its link.
Articles written when the editor offered Everyone, People who are signed in and Staff only keep who could read them: Everyone picks no role, People who are signed in picks Authenticated, and Staff only picks the roles that had the old View staff-only knowledge articles permission, and Administrator.
Suggestions in tickets
With the Service Desk on too, matching articles show as suggestions while people write:
- requesters see them on the New request form in their account, so they may find the answer before they send;
- agents see them under the reply box, and select one to add its link to their reply. A public reply suggests only articles the requester can open; an internal note suggests every article the agent may read.
See Answer a ticket and Tickets Portal.