Service Description Template
Last updated
Was this helpful?
Last updated
Was this helpful?
The Service Description article template allows you to share detailed information about a service or platform in use.
Here's an example of how a completed Service Description article looks:
Service Description articles are a common way to deliver information, but it's important to know when it is appropriate to use this format.
You should create a Service Description article to:
Deliver information about a business, technical, application, web, or any kind of service
You should not use a Service Description article to:
Troubleshoot a service application or any software
The Service Description article template gives you two pre-set sections in your article:
Service Overview
Service Level Agreements (SLAs)
These two 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.
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 "Answer" section when creating the document. See example below. Select the image to magnify:
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.
The example below showcases the correct implementation of a Service Description article. It includes the following components: a service overview, service level agreements (SLAs), 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:
The example below includes an example of a Service Description article used incorrectly. This is incorrect because it does not include any of the predefined headers that help organize the sections. It includes all of service description information, but in the wrong format. Select the image to magnify:
Type “knowledge” in the filter navigator on the left hand side and press enter.
After the “Knowledge Bases” screen loads, click the “Create an Article” button on the top right.
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.
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.
Enter a description of what the service is and what it provides. The word “Service Overview” will be shown as a heading, h3 (represented by the blue).
Enter the service level agreement here. An SLA is a contract between the service provider and the customer in which the service provider explicitly defines the quality, availability, responsibilities of the service they intend to offer. The word “Service Level Agreements (SLAs)” 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.
Enter in words that are helpful for individuals who might benefit from the document:
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.
Review your article after you publish it to make sure the information is displayed correctly.
