Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update a11y docs #60

Merged
merged 1 commit into from
Aug 26, 2024
Merged

Update a11y docs #60

merged 1 commit into from
Aug 26, 2024

Conversation

jazairi
Copy link
Contributor

@jazairi jazairi commented Aug 9, 2024

Why these changes are being introduced:

The Libraries Accessibility Team is working on a LibGuide that includes a11y guidance for staff. It would be useful to link to the a11y dev docs in that guide. However, most of the content in this section was written over six years ago, with a few edits here and there in the intervening years. Some things have changed, and others could be expanded upon.

Relevant ticket(s):

Unticketed (part of LAT work mentioned above)

How this addresses that need:

This updates the information in the a11y guide.

Side effects of this change:

There is probably more to add here, but it feels like a decent starting point.

basics/a11y.md Show resolved Hide resolved
@JPrevost JPrevost self-assigned this Aug 13, 2024
Copy link
Member

@JPrevost JPrevost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a preference to use accessibility instead of a11y when either can work in our documentation as it reads easier to me. All comments are suggestions though and not blocking. Nice refresh of the docs, thanks!

basics/a11y.md Outdated
@@ -2,67 +2,94 @@

## Background info

[The A11y Project](https://a11yproject.com/about)
Accessibility (shortened as a11y) is a primary considering in our design and engineering processes. By foregrounding
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

considering vs consideration?

basics/a11y.md Outdated

The Libraries' Accessibility Team (LAT), established in 2023, has adopted [Inclusive Design](https://www.nngroup.com/articles/inclusive-design)
as one of its guiding principles. Inclusive Design is similar to [Universal Design](https://universaldesign.ie/about-universal-design),
in that both explore the idea of meeting as many people’s a11y needs as possible. Inclusive Design focuses more on individual needs, and acknowledges that multiple design approaches may be required to meet this goal.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe
"meeting as many people’s a11y needs as possible"

basics/a11y.md Outdated
in that both explore the idea of meeting as many people’s a11y needs as possible. Inclusive Design focuses more on individual needs, and acknowledges that multiple design approaches may be required to meet this goal.

We consider Inclusive Design to be an inherently aspirational goal, as more can always be done. This is also what makes
it a useful framing device for a11y work. The human experience is incredibly diverse, and a single design is not likely to meet every person's a11y needs. We can always strive to do better.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

similarly, consider "every person's a11y needs"

My suggestion is meant to focus on needs, and not just accessibility needs which I feel is an important distinction between approaching accessibility work as "accessibility work" and approaching it as "inclusive design".

@@ -2,67 +2,94 @@

## Background info
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like we should indeed note that accessibility is often shortened to a11y but I'd prefer we use the full word in our documentation whenever we can as it reads so awkwardly otherwise.

basics/a11y.md Outdated
## Implementing open source or vended solutions

As with locally developed software, any open source or vended software that includes a UI should be evaluated for
accessibility. Any vendor claims related to a11y should be confirmed, to the extent we are able to do so. Ideally, a11y
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a note that UXWS should be contacted for assistance in doing vended UI evaluation?

@jazairi
Copy link
Contributor Author

jazairi commented Aug 13, 2024

@JPrevost All good suggestions, thanks! I think I addressed everything, but could you take another look before I rebase and merge? (Unfortunately, some changes may look larger than they are in an effort to adhere to max line width.)

Why these changes are being introduced:

The Libraries Accessibility Team is working on a LibGuide that
includes a11y guidance for staff. It would be useful to link to
the a11y dev docs in that guide. However, most of the content in this
section was written over six years ago, with a few edits here and there
in the intervening years. Some things have changed, and others could be
expanded upon.

Relevant ticket(s):

Unticketed (part of LAT work mentioned above)

How this addresses that need:

This updates the information in the a11y guide.

Side effects of this change:

There is probably more to add here, but it feels like a decent
starting point.
@jazairi jazairi merged commit c813028 into main Aug 26, 2024
2 checks passed
@jazairi jazairi deleted the a11y-updates branch August 26, 2024 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants