Issue/Question
How do I create an knowledge base article
Environment
Cause
After search with different keywords, no article is found to use for the ticket, a new article needs to be created
Resolution
Note: If the knowledge base has already been searched and no articles are found that can be used, a new article needs to be added
- Within the Knowledge Base click +New Article
- Select Appropriate Category
- Enter Subject
- Within the Body Editor Click Templates
- Select the Knowledge Article Template you want to choose between:
- Customer Facing Templates used for customer facing articles, with solutions for the customer
- Customer Facing Article with link to Internal Template
Note: DO NOT add the ITS Teams in this ITS box, otherwise the customer will start contacting ITS teams directly, it should just contain 1. Follow Internal Article Title. Team Information belongs in the Internal Knowledge Template
- Internal Knowledge Template used for internal staff only articles
Note: for departmental internal knowledge, make sure the Category starts with Internal otherwise it may be visible to the customer
Note: there are several categories that are Faculty and Staff or Students only, this will be listed in the category name, these will be listed under not public categories
- Fill In the Template to the Best of Your Knowledge, Following Style Guide
- Fill in the Summary
- Check Notify Owner on Feedback
- Click Save
- If you need to link the article to a ticket, following linking process
Adding Tags
Follow Article - Tag Guidance
Note: Too many article tags can cause search issues, articles could be displayed when not relevant
Adding Font Awesome
Note: Use of Font Awesome will add common icons to your article, these are not accessible so a description will also need to be added
- Click Insert Font Awesome
- Browse through the icons available or search
- Click the icon you want to use
- Click Okay
Adding Links
- Click
- Enter the following
- Display text
- LinkType
- URL
- Click the Target tab
- Set target to New Window (_blank)
Checking Digital Accessibility
- heading order
- image alt text
- font awesome title and text description
- AccessibilityChecker.org - ADA & WCAG Compliance (Free Scan)