Home - trussworks/accessibility GitHub Wiki

Welcome to the accessibility wiki!

You can use this wiki to find tips and recommendations on how to make your website accessible. This covers a range of topics including various form elements, patterns, implementation suggestions with rationale, examples and resources.

How to add to the wiki

The wiki is the location that the Truss accessibility guild is documenting component level a11y focused implementation suggestions. The wiki is organized by component and sections loosely uses the template provided below.

Choosing a component

We’ve created a Miro board that has a list of all the components in USWDS. This has been our starting point, mainly because a majority of our projects are using USWDS as the basis for our design systems. However this Miro board can be added to as different projects find/use components outside of that system.

Typically we choose a component that more than one Truss project has experience implementing. Once a component is chosen, the group will choose a pair to collaborate on writing up the documentation.

Pairing on documentation

The pair chosen to document the component will decide how they’d like to work together. One approach is that one person will take a first pass at the draft and then tag the pair in for feedback or edits. Another approach is to write up the documentation together during a pairing session.

This template can be used as a starting point.

Additionally, feel free to post that we are starting documentation on a new component in a few different channels (#app-eng, #design-research, #product) to see if others outside of the groups would like to contribute any knowledge as well.

Typically we will use the time between guild meetups to write the first draft. After the initial draft is written by the pair they will bring it back to the guild group for final review.

Final review and posting

Once the initial draft is complete the pair working on the component will bring it to the wiki group for final feedback. We typically present the writeup during the working group session and others are able to leave comments or make changes in real time.

Once those changes are incorporated someone from the pair will post the documentation to the wiki.

Socializing the new component

After the component has been published to the wiki. Someone from the pair should post a notification to the #g-accessibility channel announcing that the new documentation is up for folks to utilize.