Making a TeamDynamix Knowledge Article Accessible

Environment

TeamDynamix, accessibility, ITS

Issue

How do I make sure a TeamDynamix knowledge article is accessible?

Resolution

Knowledge base articles are like any other University resource and must be able to be used, understood, and participated in by all, without barriers for any individuals or communities. 

Basic accessibility concepts and principles

Basic concepts and principles for accessibility, include Alt Text, Color, Links, and Tables

Note: Underlining should not be used unless the item is linked. Bold and italics should be used sparingly. Italics can be particularly difficult to read for more than a word or two. 

Accessible headings

For TeamDynamix knowledge articles, we use the title as the top (H1) level and then subsequent heading styles in order. 

For the ITS template, that means Environment, Issue, Resolution, and Additional Information are Heading 2 (<h2>), and subsequent subheadings should be marked as Heading 3 (<h3>), Heading 4 (<h4>), and so on. 

Add a heading

  1. Select the text you want as the heading.
  2. Click on Format in the style area above the body of the article.
  3. Click on the correct heading. Do not skip headings or reformat them, just use the next default style by number.

More on Headings.

Lists

It is important to use bulleted lists for items that have no particular order and numbered lists for items that have a sequence or order.

Lists

Add accessible images (alt text) to knowledge articles

Any images in knowledge articles MUST include alternative text (alt text) to make all of our images available to people using screen readers. The alt text should describe any images so anyone using a text reader can understand them. There is helpful information on what to write in this ITS Accessibility document on Alt Text.

To add alt-text:

  1. Right or off-click on the image.
  2. Choose Image Properties.
  3. In the screen that pops up, you should default to the Image Info tab, which has the Alternative Text field.
  4. Type your text in the Alternative Text field.
  5. Click OK.

We limit the number of screenshots in a knowledge article because they can make an article long and harder to follow, they are applicable to only one screen or operating system, they aren't searchable, and they are not natively accessible. If you need to have images, they all must have alt text (including any small image screenshots).

Make content accessible

See the webpage How to Make Content Accessible for more information on how to make information linked to knowledge articles accessible.

Additional Information

Guidance on compliance requirements

University of Michigan Accessibility Standard Practice Guide: https://spg.umich.edu/policy/601.20.

Need additional information or assistance? Contact the ITS Service Center.

Print Article

Related Services / Offerings (2)

ITS-Digital Accessibility
This Service provides assistance or collaboration with making information technology (websites, documents, media) accessible to work towards meeting the requirements of the EIT Accessibility Standard Practice Guide on campus.
ITS-TeamDynamix
This service is a web-based platform that provides service management, asset management, and project management capabilities. TeamDynamix can support IT management and support functions and has capabilities that provide general customer support or management of other non-IT functions like facilities and human resources too.