Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel12
maxLevel6
outlinefalse
typeflat
separatorpipe
printablefalse

...

Overview

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

...

Info

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. 

...

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.

Info

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

Image Removed
Image Added

Building the knowledge base system

...

Table of Contents
minLevel3
maxLevel3
outlinefalse
typelist
printablefalse

Step 1 - Create the template

Expand
titleCreating 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; SummaryDiagnosisCauseSolutions using the Paragraph field type

Image Removed
  • Image Added

For the System field

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

  • edit the field, to add your list options
    Image Removed

    Image Added
  • Save save the template

Step 2 - Create a knowledge base article

Expand
titleStep 2 - Create Creating a knowledge base article

Create a new page

.

Add

  • add a Live Template macro

.

Image Removed
  • Image Added
Locate
  • locate the template Knowledge Base Article Template

.

Image Removed
  • Image Added
Save
  • save the macro

and
  • publish the page

.

Step 3 - Add content

Expand
titleStep 3 - Add Adding content
Click on 

On the published page

  • choose Edit Content to turn the page into a form

.

Image Removed
  • Image Added

Populate
  • populate the fields on the form

.

Image Removed
When you're done, click
  • Image Added

  • choose Publish Content

.
Info

That's it!

...

You now have a knowledge base system in your Confluence site!

...

See more Recipes.