(MOVED) Knowledge Base Article(s) Guidelines

Owned by Nathan Confer, created
Last updated: Jul 05, 2023 by Connor Nicewonger
2 min read

These articles will serve as a structure for creating KB/Troubleshooting articles in Confluence

As a basis for ALL articles, be sure to use proper grammar and DO NOT include the word "you" (in reference to who articles are directed at) in any way. Please proofread articles to verify accuracy of content.

DO NOT include personally identifiable information. Replace any names, emails, phone numbers that could be linked to yourself, staff, or students with generic information.

 

How-to articles

Describe how this guide is most effective for what the article is being wrote for

  1. Begin with the most relevant step to start the process

  2. Continue the written walk-though processes for each step

    1. Based on the article, organize it's layout by using Sections, Columns, Expand and/or Panel macros

      1. Use sublists for keeping troubleshooting steps organized and most relevant

Troubleshooting articles

Problem

Give an overview of the issue the article is being wrote for and describe how the process will be applied to amend the issue

  1. Begin with the most relevant troubleshooting step(s) to help eliminate easy fixes

  2. Continue on with a list, or add other elements such as Sections, Columns, Expand and/or Panel macros to help maintain an organized layout

    1. Use sublists for keeping info. together, and insert more detail

      1. Use images/links, bold, italicize and underline to highlight important info.

Footer info.

 

 

Related articles

Filter by label

There are no items with the selected labels at this time.