Knowledge Article and Service Description Guides

Instructions for writing knowledge base articles and service descriptions, as well as style guides and word usage information.

Categories (1)

Documentation Guidelines

Writing and style guides, standard usage guides, copyright information, glossaries
Expand

Articles (8)

Pinned Article Creating and editing knowledge 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.

Knowledge Base New Article Checklist and Article Review Checklist

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

Adding Related Articles and Related Services to 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.

Internal and Archived Articles

To help ensure that archived and internal articles are not used in tickets, their titles should have the appropriate prefix at the beginning.

Knowledge Base Categories

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

Create a table of contents in an article

If an article has multiple sections, it will benefit from a table of contents.

Using Bootstrap in KB articles: Buttons

Buttons can be used for logging into systems and for downloading files.

Knowledge Base Training by TeamDynamix

Knowledge base articles by TeamDynamix