Known Issue Template

Overview

The Known Issue article template allows you to share information about a known issue that has a resolution.

Example of Known Issue Article

Here's an example of how a completed Known Issue article looks:

Use Cases

Known Issue articles are a common way to deliver information, but it's important to know when it is appropriate to use this format.

When to use

You should create a Known Issue article to:

Deliver information about a known technical issue that has a resolution

When to NOT use

You should not use a Known Issue article to:

Deliver information about that doesn't have a resolution

Anatomy of the Form

Main Sections

The Known Issue article template gives you three pre-set sections in your article:

Details
Workaround
Resolution

These three sections have predefined headings. This means that each section will have their corresponding headings applied by default. You do NOT need to create these headings. You will be able to view the headings after you've published your article.

Reference the image below to see the headings that are automatically applied. Select the image to magnify.

Sub-Headings & Accessibility Requirements

Because headings are applied automatically as H3 Heading elements, you will need to use the H4 headings if you decide to add a child heading to each of the corresponding sections.

Reference the image below for an example of an H4 Heading being applied. Select the image to magnify.

You can support your article with a related articles section. This may help your customer answer another question they may have similar to that topic. This section needs to be manually added at the end of the "Resolution" section when creating the document. See example below. Select the image to magnify:

Adding Images

To add images to your article, you may either copy and paste the images in text field, or you can select the insert image tab and upload an image from your computer.

Good vs. Bad Examples

Good Example

The example below showcases the correct implementation of a Known Issue article. It includes the following components: a details, workaround, resolution, and an optional related article section. All unrelated information to the question, but related to the topic is linked below the article. Select the image to magnify:

Bad Example

The example below includes an example of an FAQ article used incorrectly. This is incorrect because it includes a "How to set up EMFL" section. This portion of the article is out of the scope of the question. This portion could have been placed in a "How To" knowledge article and then linked under a "Related Articles" section. In addition, the title of the article doesn't match the question posed under the question header. Select the image to magnify:

How to Implement Template

Step 1: Navigate to Knowledge Bases

Type “knowledge” in the filter navigator on the left hand side and press enter.

Step 2: Find “Create Article” Option

After the “Knowledge Bases” screen loads, click the “Create an Article” button on the top right.

Step 3: Choose Knowledge Article Type

First select the knowledge base that you want your article to be stored in. Then, select the article template that you want. This will populate a preview of that template with sample text. If it is representative of way you want to deliver the information, click next. If not, select another template that may be more representative.

Step 4: Populate Required Fields

Fill out information to properly categorize your article. In the short description field, enter a brief description of the content of the article. Describe in twelve words or less. This will be the title of your article.

Step 5: Enter Knowledge for KB Article

Details

Enter details of the current issue. The word “Details” will be shown as a heading, h3 (represented by the blue)

Workaround

The workaround section should include any temporary actions the user should take while the service is down. The word “Workaround” will be shown as a heading, h3 (represented by the blue)

Resolution

Check off the resolution box (green box) and explain what the details of the resolution (red box) so that the user may resolve the issue themselves. The word “Resolution” will be shown as a heading, h3 (represented by the blue)

Below the answer, manually enter "Related Article" and then tag the link to the title of the related article.

Step 6: Save & Publish

Select the “Save” button to save your knowledge article. Then select the “Publish” button to publish your article to the KB article destination that you selected.