How do you format a knowledge base article?

How do you format a knowledge base article?

8 best practices for writing effective knowledge base articles

1. Don’t make assumptions.
2. Use anchor links in lengthy articles.
3. Make the content easy to skim.
4. Make things easy to read.
5. Organize your knowledge base article logically.
6. Use links strategically.
7. Stick with simple article titles.

How do you structure a knowledge base?

Here’s the basic process of building a knowledge base:

1. Decide on the core elements of your knowledge base.
2. Choose your knowledge base content.
3. Agree on the structure of your knowledge base articles.
4. Write your knowledge base articles.
5. Add visuals to your content.
6. Publish your knowledge base.
7. Analyze and improve your articles.

How do you write help content?

Users looking for help content are almost always frustrated, so in your writing, use a sensitive voice and tone, and avoid condescension at all costs. Here’s how: do not include obvious statements or redundant information; break up text with subheadings so users can skim for the appropriate topic; and.

How to make a KB Article publicly available?

Completing this step will make any KB article without an assigned role available to any unauthenticated user! In order to make your Knowledge Base available without authentication you need to make the UI components (UI pages and UI macros) that display the knowledge base publicly available. This is done via the ‘Public Pages’ table.

How to create an effective knowledge base article?

Creating an effective knowledge base article takes some planning. You want to make sure that each article addresses a real customer issue and that the information is presented in a logical way. You should refer to your knowledge base content plan when selecting the topic for your article.

Which is the correct URL for KB Home?

KB Home URL is equal to the URL of the page that contains KB shortcode See Changing Permalinks, URLs, and Slugs article about where to change the URL. Knowledge base article has its URL address composed of the following: The initial KB Articles Base Slug is set to “knowledge-base” .

How to control public availability of knowledge base content?

You can activate the module if you don’t see it in the list, or you can simply type ‘sys_public.list’ in the left nav filter to bring up the table. The ‘Public Pages’ table shows every page in the system that is available to unauthenticated users. Not all of these records are active however.