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

Articles (12)

Using the TeamDynamix editor to create accessible knowledge base articles and service descriptions

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.

Styles for Commonly Used Words and Phrases

A usage list of words and phrases that are often misused, confused, and questioned in documentation.

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.

IT Services Glossary

IT Services Glossary

Writing Guides and Glossaries

Glossaries, dictionaries, and acronyms

Create a table of contents in an article

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

IT Services and University Standard Terminology

When creating documentation, use the standard terms for IT services assets and functions.

Making accessible Microsoft documents and PDFs

Making accessible Word documents, Excel spreadsheets, PowerPoint presentations, Outlook emails, OneNote notes, InDesign files, PDFs, and forms

Copyright Infringement

It is a violation of the Code of Computing Practices for any user to commit copyright infringement using university resources. Copyright infringement can also result in civil and criminal penalties with fines ranging from $750 to $30,000 per work infringed.

TeamDynamix related articles and services

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.

Copyright Resources

Laws and alternatives to illegal file sharing