Instructions and best practices for writing knowledge base articles.
Introduction and overview of the knowledge base on the UARK Help Portal.
Directions for employees to get knowledge base editing and managing access or knowledge base articles.
Checklists to use when creating a new KB article or editing a KB article.
Directions on how to create a new knowledge base category.
How to make an article or category appear in more than one location.
How to use acronyms, abbreviations, and unusual words in TDX knowledge base articles
Attach associated files such as PDFs to articles.
The guidance in these documents concerns using correct grammar and punctuation, ensuring ADA compliance, and keeping a consistent style in TeamDynamix (TDX) knowledge base articles and service descriptions to ensure university brand integrity. Follow the guidance on headings, images, links, videos, and PDFs to maintain compliance in knowledge articles and service descriptions that you create or edit.
Use Related Articles and Related Services to display links to related articles and services on the right side of the article or service, and select to display a service request button in the article.
To help ensure that archived and internal articles are not used in tickets, their titles should have the appropriate prefix at the beginning.
If an article has multiple sections, it will benefit from a table of contents.
Buttons can be used for logging into systems and for downloading files.
Using Microsoft Word to create new knowledge base articles
How to create accessible headings in TDX knowledge base articles
Reviewing your knowledge base articles
Outdated articles that will not be updated should be archived.
How to create accessible links in TDX knowledge base articles
How to create accessible lists in TDX knowledge base articles
Optimizing your knowledge base article for the Help Portal search
How to add good tags to articles
How to insert accessible images into TDX knowledge base articles
How to create accessible tables in TDX knowledge base articles
Make sure your videos are accessible and ADA compliant.
Knowledge base articles by TeamDynamix