Home » Categories » Information Technology Services

How to format KB articles

ISSUE

How to format KB articles

ENVIRONMENT

Windows

CSCC KB

RESOLUTION

The following considerations should be made when creating KB articles to be ITIL compliant:

  • The KB article should include the headings of ISSUE, ENVIRONMENT, RESOLUTION, CAUSE, and METADATA
  • The contents of the ISSUE section should match the title of the KB article and should be descriptive and concise to ensure that searching will provide the KB user with the most relevant results
  • The contents of the ENVIRONMENT section should list the environments in which the user will operate while experiencing the issue
  • The contents of the RESOLUTION section should include the steps/measure to take to resolve the issue.  This section can include links to other KB articles, graphic images, steps, etc.
  • The contents of the CAUSE section should include the cause of the issue, if known
  • The contents of the METADATA section should include the AUTHOR, CREATED DATE, and MODIFIED DATE.  If the KB article is modified by a user other than the original creator, the user performing the modification should then list their name as the AUTHOR along with the date the article was modified.

KB ARTICLE EXAMPLE

ISSUE

How to use the KB Syntax Highlighter

ENVIRONMENT

Windows

CSCC KB

RESOLUTION

Use the syntax highlighter when you need to inset source code.

CAUSE

N/A

METADATA

Author: Christopher Bunner

Created Date: 8:50 November 20, 2014

Modified Date: 8:50 November 20, 2014

CAUSE

N/A

METADATA

Author: Christopher Bunner

Created Date: 9:00 August 30, 2016

Modified Date: 9:00 August 30, 2016

0 (0)
Article Rating (No Votes)
Rate this article
  • Icon PDFExport to PDF
  • Icon MS-WordExport to MS Word
Attachments Attachments
There are no attachments for this article.
Related Articles RSS Feed
OnBase Unity Client Desktop Install Instructions
Viewed 8914 times since Dec 15, 2015
How to Access and Use files.cscc.edu
Viewed 8087 times since Feb 26, 2015
How to Share Outlook Subfolders
Viewed 54062 times since Jun 5, 2015
How to get the serial number or name of a computer?
Viewed 4952 times since Sep 29, 2014
How do I discover my CSCC Password - New Employee/First Time User?
Viewed 4734 times since Feb 5, 2015
How to Set Up Email on an Android Device
Viewed 32010 times since Nov 5, 2015
How to Set Up Email on an Apple iOS Device
Viewed 62779 times since Nov 5, 2015
How to view a Proxy Account in Outlook Web (In a web browser)
Viewed 14898 times since Mar 5, 2015
How to recreate an Outlook profile
Viewed 97489 times since Apr 16, 2014