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
283 stars 204 forks source link

Identify descriptive tags (fka tertiary information) for each standard and applicable labels #63749

Closed shiragoodman closed 1 year ago

shiragoodman commented 1 year ago

User Story

As a Governance team member, I want to identify all of the "tertiary" level information that could provide additional context to each standard so that OCTO can track more nuanced information related to the standards violations.

Assignee: @erinrwhite Peer Reviewer: @allison0034

Description

The new VA.gov Experience Standards are not as specific and/or as detailed as the older version. They are written to communicate to the VFS team what the problem is that the user/veteran is experiencing. However, there is still more specific and detailed information that Governance team wants to capture. We have been referring to this information as tertiary information as it comes after the primary information (category) and the secondary information (standard). The purpose of this ticket is to identify the different types of tertiary information that should be captured in a VFS team Staging Review when a standards violation is identified.

In addition, this ticket will identify the relationship the tertiary information has with the standards violation. For example, when a staging review findings ticket impacts a Design System component, it is for 1 and only 1 DS component. However, if another Staging Review findings ticket impacts WCAG success criteria, it is possible that the standards violation could map to 1 to many different WCAG success criteria.

Tertiary information captured so far:

Impacted Artifacts

Tasks

Peer Review

To be completed by peer reviewer

Acceptance Criteria

Team Notification

How to prepare this issue

Refinement

briandeconinck commented 1 year ago

@erinrwhite In case you don't get to this until I'm already out of office, here's a spreadsheet with some proposed labels for WCAG and for what I'm calling interaction modality, which is my arbitrary broadening of devices to include some stuff that's not strictly speaking a device.

shiragoodman commented 1 year ago

thank you for sharing this, @briandeconinck !

erinrwhite commented 1 year ago

@briandeconinck thank you so much for these! I'm generating reference link for the WCAG tags. Confirming, should I reference WCAG 2.2 documentation or an earlier version?

briandeconinck commented 1 year ago

For now you should use the 2.1 documentation. 2.2 is still not officially adopted by the W3C, and then once it's the standard we'll have to work through adopting it for Platform.

I'll note that everything should be the same between 2.1 and 2.2 except for the items I noted in the spreadsheet.

erinrwhite commented 1 year ago

@briandeconinck Thank you! Should we keep the items that are new in 2.2 or add those in down the line?

shiragoodman commented 1 year ago

I'd recommend waiting. There's a lot we'll need to do when 2.2 is enforced across the VA. No need to make the effort now.

erinrwhite commented 1 year ago

@it-harrison Can you take a look at the suggested descriptive tags I have so far?

erinrwhite commented 1 year ago

@briandeconinck @allison0034 Sharing suggested descriptive tags with you before Brian heads out on leave - thank you again Brian for the list of WCAG and modality tags.

Big questions:

cc @shiragoodman @it-harrison

thanks team!

shiragoodman commented 1 year ago

@erinrwhite this looks AWESOME. Thank you so much for putting in the time and effort. I think this will be well received by OCTO practice area leads.

allison0034 commented 1 year ago

@shiragoodman @erinrwhite these look good. I assume as we do reviews we will discover we need to add more tertiary labels. That wont be a problem correct? I specifically think there will be some around design principals.

shiragoodman commented 1 year ago

@allison0034 correct. We can always add more later, but I think this is good enough for now :)

erinrwhite commented 1 year ago

Based on team discussion yesterday it sounds like we are set to close this ticket and ship these labels as-is, understanding that there will be refinements down the road. 👍🏻