 Knowledge Article and Service Description Guides

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.

Creating and editing accessible links in knowledge base articles

Checklists to use when creating a new KB article or editing a KB article.

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.

TeamDynamix knowledge base articles and services are organized into categories with subcategories. The categories have been set up according to Educause Categories.

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.

Reviewing your knowledge base articles

How to add good tags to articles

Knowledge base articles by TeamDynamix