department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
282 stars 202 forks source link

Review and finalize accessibility testing plan for VADS publishing #90358

Closed shiragoodman closed 1 month ago

shiragoodman commented 2 months ago

User Story

As a content and IA specialist on Governance team, I want to review the Accessibility Testing Plan documented by Governance and DST a11y specialists to modify/edit it for a VFS audience and VFS-facing consumption on the VA Design System website.

Assignee: @erinrwhite @KKitagawa-Bosch Peer Reviewer: @shiragoodman

Description

Governance and DST team members wrote an accessibility testing plan for VADS components that now needs to get ready to publish to the VADS. The purpose of this ticket is to have Governance content and IA specialists review the document and make edits/modifications to ensure it's easily understood by VFS teams, as well as to ensure it follows our own standards for content and IA on VA.gov.

This ticket will also include a review of the current Accessibility page on VADS. The Accessibility testing plan will live as a new document under the Accessibility hierarchy. The goal is to have both pages aligned and cohesive.

Impacted Artifacts

Tasks

Peer Review

To be completed by peer reviewer

Acceptance Criteria

Team Notification

How to prepare this issue

Refinement

briandeconinck commented 1 month ago

@erinrwhite and @KKitagawa-Bosch the accessibility testing plan draft is ready for you to do your thing!

briandeconinck commented 1 month ago

Please ping me with any questions / things that aren't clear in what @rsmithadhoc and I have so far.

erinrwhite commented 1 month ago

thanks @briandeconinck !

@briandeconinck and @rsmithadhoc: Can y'all verify that the purpose of this new page is to share our accessibility testing process for VADS components? Or will it be a resource for VFS folks hoping to understand how to complete accessibility testing in general? Or both? Either way, we will need to be very clear with the title of the page. thank you!

@KKitagawa-Bosch I have created draft copies of the pages in Confluence I can spend a little time Wednesday morning reviewing the structure/flow of the doc, as well as headings, links and crosslinking. Then I could toss it to you?

briandeconinck commented 1 month ago

Good clarification! The purpose of this document is to describe how design system components are tested -- nothing else.

Not in scope: patterns and templates (not yet anyway!) and VFS products.

I think there's a lot VFS teams could learn from the document, but it's not prescriptive "you should do this" or even a "how to do this if you want to" document.

shiragoodman commented 1 month ago

great questions! Happy to jump in and help too, if needed. Brian is right. It's not a "you should do this" or a "how to do this if you want", but instead it's a "this is what was done."

Please let me know if you need anything!

erinrwhite commented 1 month ago

thanks @briandeconinck and @shiragoodman! This is helpful info...

@KKitagawa-Bosch I have taken the first pass at the Accessibility testing page structure - including adding some comments with questions for you. Big picture, there is some VFS-facing guidance in there that I think we should actually port to the Accessibility page. If that sounds good to you, could you start on that? 😸

KKitagawa-Bosch commented 1 month ago

@erinrwhite

Answered those questions on Accessibility testing page structure and moved that info to the Accessibility page. Also added a comment/question on the Accessibility page!

erinrwhite commented 1 month ago

@KKitagawa-Bosch after a couple days away I moved those specific instructions for VFS teams back into the components testing doc 😂

Can you take a look? Paging @shiragoodman and we still need to get eyes from Brian and Ryan as well.

KKitagawa-Bosch commented 1 month ago

@erinrwhite seems good to me! I would have (B)R(y/i)an take a look!

erinrwhite commented 1 month ago

@briandeconinck @rsmithadhoc

Hi you two! We have been working on suggested updates to the accessibility testing and accessibility pages in VADS:

@shiragoodman thoughts on how to proceed once Brian and Ryan have reviewed? A pull request for this in GitHub?

shiragoodman commented 1 month ago

this ticket can be closed when Shira and Brian provide feedback. We do not need fb from Matt, Carol and/or Ryan in order to close this ticket.

shiragoodman commented 1 month ago

@erinrwhite @KKitagawa-Bosch @briandeconinck I think both new pages look good. The only comment I have is on the new Accessibility Testing Page. The Testing Methodology section is basically the categories of the Accessibility Component checklist which is included on each component page (or apparently, only for the ones that have a BEST PRACTICE maturity scale). There's no content that ties this section of the doc back to the component checklist.

The accessibility component checklist is changing, so the live versions on component pages now (such as list) will not align with what's in the Testing Methodology section, but please make an attempt to connect the 2. Please lmk if you have any questions.

erinrwhite commented 1 month ago

This ticket has carried over to the next sprint so that there is more time to review on the drafts.

erinrwhite commented 1 month ago

@erinrwhite @KKitagawa-Bosch @briandeconinck I think both new pages look good. The only comment I have is on the new Accessibility Testing Page. The Testing Methodology section is basically the categories of the Accessibility Component checklist which is included on each component page (or apparently, only for the ones that have a BEST PRACTICE maturity scale). There's no content that ties this section of the doc back to the component checklist.

The accessibility component checklist is changing, so the live versions on component pages now (such as list) will not align with what's in the Testing Methodology section, but please make an attempt to connect the 2. Please lmk if you have any questions.

@briandeconinck I think this is maybe a question for you - is there a way to explicitly tie the current or future version of the accessibility checklist that appears on each component's page back to this accessibility testing for components page?

Screenshot 2024-09-03 at 4 07 44 PM

briandeconinck commented 1 month ago

@erinrwhite and @KKitagawa-Bosch Finally coming back to this! I've made some very minor edits, plus added another section to the end of the document to address @shiragoodman's comments. Could you all read what I've added and make any edits needed if it doesn't make any sense?

Otherwise I think this looks great and is good to go! cc @rsmithadhoc

KKitagawa-Bosch commented 1 month ago

Looks good to me @briandeconinck !

erinrwhite commented 1 month ago

@briandeconinck What's the new section you added? Not sure I'm seeing it...

briandeconinck commented 1 month ago

@erinrwhite Very bottom of the testing page, the bit about the component checklist (after the methodology section)

erinrwhite commented 1 month ago

@briandeconinck Is your version published? This is what I'm seeing at the bottom of the page...

Screenshot 2024-09-06 at 11 37 38 AM

briandeconinck commented 1 month ago

@erinrwhite Apparently not! But they are now! Accessibility testing page, now with bonus content

erinrwhite commented 1 month ago

@briandeconinck That looks excellent! @KKitagawa-Bosch One last look? Then I think the next step is that we share with Matt and Carol - @briandeconinck @rsmithadhoc does that make sense, or do y'all want more time?

briandeconinck commented 1 month ago

I am good to let this move on to the next thing 🙂

KKitagawa-Bosch commented 1 month ago

Looks good to me! Love the example, that clarified all the questions I had from the first part lol

erinrwhite commented 1 month ago

Shared with Carol and Matt on Slack.

@KKitagawa-Bosch I think this means we are good to close. Can you review?

KKitagawa-Bosch commented 1 month ago

Looks good to me! Good to close @erinrwhite

erinrwhite commented 1 month ago

thank you!