Skip to end of banner
Go to start of banner

Creating knowledge base system

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Overview

A knowledge base is a self-serve repository of articles about a product, service, department or topic.

Your knowledge base isn't just helpful for customers, it's also useful for your team. A well-structured, clearly-written, and cleanly-designed knowledge base helps customers help themselves, acts as a learning tool, and can even be a source for machine learning. 

In this example, we will build a knowledge base system using Scaffolding.

The knowledge base articles will share the same format, layout and sections

  • your team members will use the template to create knowledge base articles

  • Confluence users can then access the knowledge base article to get information

You can also make changes to the template in the future, which will automatically update all the pages your users have created. 

Sample Use Case

Background

Your users have reported that page exports have failed.

Solution

You want users to be able to search your Knowledge Base before coming to you as this is a known issue that can be resolved via self help.

For you as as the administrator you want to be able to create a template that can be edited with one click and change reflected on every page using the template.

Final Outcome

You have setup a Knowledge Base space, then created a live template for KB with Scaffolding Cloud using key fields you created using Field Group macro. 

End Result

Building the knowledge base system

 Step 1 - Create the template

Go to

  • Space Settings > Look and Feel

  • add a new template

  • name the new template as Knowledge Base Article Template

  • add a Field Group macro by typing /field

In the macro editor

  • add the necessary fields; Summary, Diagnosis, Cause, Solutions using the Paragraph field type

For the System field

  • add a table and make use of the Dropdown List type

  • edit the field, to add your list options

  • save the template


 Step 2 - Create a knowledge base article

  1. Create a page.

  2. Add a Live Template macro.



  3. Locate the template Knowledge Base Article Template.


  4. Save the macro and publish the page.


 Step 3 - Add content

  1. Click on Edit Content to turn the page into form.



  2. Populate the fields on the form.



  3. When you're done, click Publish Content.



That's it! Now you have a knowledge base system in your Confluence!

See more Recipes.


  • No labels