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

Restore ACT branding & navbar #103

Merged
merged 28 commits into from
Jun 16, 2022
Merged

Restore ACT branding & navbar #103

merged 28 commits into from
Jun 16, 2022

Conversation

WilcoFiers
Copy link
Collaborator

@WilcoFiers WilcoFiers commented May 20, 2022

This pull request makes a few changes:

  1. Update the title from "WCAG 2 Test Rules" to "Accessibility Conformance Testing (ACT)" and makes it into a link
  2. Add a navbar with All Rules, About, and Test Tools & Methodologies
  3. Remove the "About WCAG 2 Test Rules" link from the head (it is in the navbar now)
  4. Updates the tagline from "For developers of evaluation tools and test methodologies" to "Harmonised rules for WCAG 2 & ARIA"
  5. Renames "Test Rules" to "ACT Rules", clarifying that ACT also covers non-WCAG things in further texts.
  6. Renames the Test Rules list to "Rules for WCAG 2"
  7. Split the Proposed rules list up into "Proposed Rules for WCAG 2" and "Other Proposed ACT Rules"
  8. Various editorial changes in All ACT Rules, and About ACT Rules
  9. Do more cross-linking to various places
  10. Flag Rule list & About pages as draft, since this hasn't been OK'ed by AG / W3C before

There is no "Approved non-WCAG rules" list, because there are none. In case you're wondering. We're going to have ARIA rules at some point, but those aren't ready yet.

@WilcoFiers WilcoFiers changed the title Layout work Restore the navbar May 20, 2022
@WilcoFiers WilcoFiers marked this pull request as ready for review May 20, 2022 16:41
@SteveALee
Copy link
Contributor

SteveALee commented May 20, 2022

@WilcoFiers could you please add a brief description identifying the requirement and outlining the approach? Thanks

@shawna-slh
Copy link
Contributor

@WilcoFiers , A succinct list of proposed changes in the PR would be helpful -- some of us can process that much easier than the files changed diffs, thus we could reply faster.


There is support for some of this. I am working on consistency across related designs/resources. I hope to get back to this specific proposal next week. Thanks for your patience in the meantime.

@shawna-slh shawna-slh marked this pull request as draft May 20, 2022 17:51
@WilcoFiers WilcoFiers force-pushed the layout-work branch 2 times, most recently from 7fdef99 to 31b2e47 Compare May 21, 2022 10:47
@WilcoFiers WilcoFiers force-pushed the layout-work branch 2 times, most recently from 37efb06 to 7294ca6 Compare May 23, 2022 09:15
@WilcoFiers WilcoFiers force-pushed the layout-work branch 2 times, most recently from 57cd842 to 19490b8 Compare May 23, 2022 11:33
Copy link
Contributor

@daniel-montalvo daniel-montalvo left a comment

Choose a reason for hiding this comment

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

This is great work! Just some comments and suggestions for consideration.

_config.yml Outdated Show resolved Hide resolved
_config.yml Show resolved Hide resolved

Guidance for others is in <cite>Understanding WCAG</cite> and <cite>WCAG Techniques</cite>. **Learn about the different WCAG support material from [The WCAG 2 Documents {% include_cached icon.html name="different-view" %}](https://www.w3.org/WAI/standards-guidelines/wcag/docs/).**
ACT Rules describe how to test conformance of accessibility standards such as [Web Content Accessibility Guidelines (WCAG) {% include_cached icon.html name="different-view" %}](https://www.w3.org/WAI/standards-guidelines/wcag/) and [WAI-ARIA {% include_cached icon.html name="different-view" %}](https://www.w3.org/WAI/ARIA/). ACT Rules inform accessibility testers on how to evaluate edge cases in way that is consistent with other accessibility testers, test tools, and methodologies. ACT Rules are informative — that means they are not required for determining conformance to WCAG or ARIA.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
ACT Rules describe how to test conformance of accessibility standards such as [Web Content Accessibility Guidelines (WCAG) {% include_cached icon.html name="different-view" %}](https://www.w3.org/WAI/standards-guidelines/wcag/) and [WAI-ARIA {% include_cached icon.html name="different-view" %}](https://www.w3.org/WAI/ARIA/). ACT Rules inform accessibility testers on how to evaluate edge cases in way that is consistent with other accessibility testers, test tools, and methodologies. ACT Rules are informative — that means they are not required for determining conformance to WCAG or ARIA.
ACT Rules describe how to test conformance of accessibility standards such as [Web Content Accessibility Guidelines (WCAG) {% include_cached icon.html name="different-view" %}](https://www.w3.org/WAI/standards-guidelines/wcag/) and [WAI-ARIA {% include_cached icon.html name="different-view" %}](https://www.w3.org/WAI/ARIA/). ACT Rules inform accessibility testers on how to consistently evaluate edge cases. ACT Rules are informative — that means they are not required for determining conformance to WCAG or ARIA.
  • I think we should communicate that rules inform how to consistently evaluate accessibility standards and best practices. Comparison between different tools and methodologies should be out of scope here.
  • Why "edge cases" only? Certainly that's where interpretation needs to be harmonized, but the rules do not only have such cases.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm not sure about this one... consistency isn't a meaningful term unless you say what it is consistent with. The goal of ACT is to harmonise WCAG testing; to get greater consistency between testers; to improve inter-rater reliability if you will. By not saying "other tools and methodologies" I think it makes it sound like testers aren't consistent with themselves. That's inner-rater reliability, not inter-rater reliability. That's not what we're doing.

The goal is improved consistency between different testers. I think we have to say that. People won't know that's what we're doing if we don't say so.


{::nomarkdown}
{% include box.html type="end" %}
{:/}

The [List of Test Rules for WCAG 2](https://www.w3.org/WAI/standards-guidelines/act/rules/) is updated periodically. The rules are developed according to the [Accessibility Conformance Testing (ACT) Rules Format 1.0 {% include_cached icon.html name="different-view" %}](https://www.w3.org/WAI/standards-guidelines/act/) standard.
## What are ACT Rules
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## What are ACT Rules
I think this should be either "What ACT Rules are" or "What are ACT Rules?"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I didn't think so. Looking on other WAI pages, even when headings are questions they don't include question marks. Here's an example: What is accessibility

content/about.md Show resolved Hide resolved
content/about.md Show resolved Hide resolved
content/about.md Outdated Show resolved Hide resolved
content/about.md Show resolved Hide resolved
content/implementations.md Show resolved Hide resolved
content/index.md Outdated

## Proposed Rules for WCAG 2

These ACT Rules are used to test conformance issues of WCAG 2.0 or 2.1. These rules will be considered for approval once they are fully implemented in at least one test tool or methodology.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't understand "conformance issues' in this context. Is it that the rules "harmonize how to test conformance"? Or that the rules "reduce ambiguity for testing conformance"?

Copy link
Collaborator Author

@WilcoFiers WilcoFiers Jun 7, 2022

Choose a reason for hiding this comment

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

I'm updating this to say "test conformance of WCAG 2.0 or 2.1" Does that help?

Copy link
Contributor

Choose a reason for hiding this comment

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

That is clearer for me now. Thanks.

@shawna-slh
Copy link
Contributor

shawna-slh commented May 26, 2022

I finally cleared some time and headspace to put on a few user hats, and WAI outreach and website coordinator hats. I don’t know enough about frequent ACT Rules users to be able to wear that hat. A couple hats I could wear: 1. someone who lands on these pages without any context — including someone who is new to accessibility and would be overwhelmed with this level of detailed, complex technical info. 2. someone wanting to learn more about specific tools that they might want to use.

Notes:

  • apologies that my comments aren’t more polished and succinct; I ran way over time on this
  • I didn’t read all of the text, and I didn’t read all of the information in this pull request
  • Wilco asked for me to put all comments in this pull request, and not create separate issues for different points

So here goes:

@shawna-slh
Copy link
Contributor

shawna-slh commented May 26, 2022

[rationale] Primary user needs that we addressed with this redesign include:

[suggestion] Based on that, I think it’s very important that the banner include ‘For developers of test tools and methodologies’. Other users need to know that this detailed, complex technical info is not something they need to try to wade through and understand. Also, I think if that’s in the banner, then we don’t have to have ‘not required to meet WCAG’ in the banner like we do for Understanding, Techniques, and Supplemental Guidance (provided it’s elsewhere on the pages, per below).

[rationale] Probably every page, including every test rule, needs to say that it is not required for conformance to WCAG. That is the case for Techniques e.g., w3c/wai-minimal-header-design#4 For the Rules, perhaps the following is sufficient:

[suggestion] for clearly communicating not required wherever people land:

  • In About page Summary box, leave ‘ACT Rules are informative — that means they are not required for determining conformance to WCAG.’
  • In All ACT Rules Summary box, add: ‘ACT Rules are informative — that means they are not required for determining conformance to WCAG.’
  • To all rules pages, add: ‘ACT Rules are informative — that means they are not required for determining conformance. The basis for determining conformance to WCAG is the success criteria from the WCAG standard — not the ACT Rules.’ Probably this is best added with heading of ‘ACT Rules are Informative’ at the end of the main conten, right before the ‘Help improve this page’ box. Possibly it would be sufficient in the page footer, before the Rule Identifier.

[rationale] Put on the hat of a designer or developer looking for guidance on XYZ... From a search engine you land on an ACT Rule. Most will probably be overwhelmed and just leave the page. Some will click on About. >switch hats< Won’t you please help them find their way to more relevant resources? Since these Rules use the ‘minimal header’ without all the WAI site navigation, a hand out would be appreciated.

[suggestion] In the About Summary box, leave this existing content from https://www.w3.org/WAI/standards-guidelines/act/rules/about/

ACT Rules are primarily for developers of evaluation tools and test methodologies.
Guidance for others is in Understanding WCAG and WCAG Techniques. Learn about the different WCAG support material from The WCAG 2 Documents.

[background] One reason for changing the banner (essentially rebranding from ‘WCAG 2 Test Rules’) was because some people are familiar with ‘ACT Rules’. However, I don’t see ‘ACT Rules’ in the first two lines at all right now.

[suggestion] Here’s an approach to having a succinct catchy banner yet still writing out ACT soon:

  • change banner text from ‘Accessibility Conformance Testing (ACT)’ to ‘ACT Rules’
  • change navigation text from ‘All Rules’ to ‘All ACT Rules’
  • probably change navigation text from ‘About’ to ‘About Accessibility Conformance Testing (ACT) Rules’ and make it the last item in the nav
  • spell out ‘Accessibility Conformance Testing (ACT) Rules’ as soon as feasible in the summary and/or main content

@shawna-slh
Copy link
Contributor

[!important] WCAG and ARIA and not required for conformance

[rationale] Many people do not understand the relationship between WCAG and ARIA. I’ve heard people think ARIA is a replacement for WCAG. I’ve heard people – who have spent a lot of time and effort trying to understand what they are required to do legally -- think that they have to implement all of ARIA in order to conform to WCAG.

It’s important that this Rules resource helps avoid misunderstandings, and does not further contribute to confusion.

[suggestion] Therefore, I suggest editing: “This page contains list of ACT Rules to test conformance Web Content Accessibility Guidelines (WCAG), WAI-ARIA and other accessibility practices.” and “…for determining conformance to WCAG or ARIA.”


More broadly, I wonder about calling out ARIA at all? We talked about having “Rules for WCAG 2” and “Rules for ARIA”; however, I’m not sure if that’s needed or useful or do-able or the right way to present it? I note that ‘ARIA required context role’ and ‘ARIA required owned elements’ are to test WCAG ‘1.3.1: Info and Relationships’. If there is a list of WCAG 2 and a list of ARIA, it’s not clear where and why they go in which list.

Oh, now I notice a new section has been added “Other Proposed ACT Rules” that says: These ACT Rules are not required for conformance to WCAG. They are part of various other accessibility standards and best practices, such as WAI-ARIA and Techniques for WCAG 2 .

-- I scroll up and see that new text has been added to the previous sections:

These ACT Rules are used to test conformance issues of WCAG 2.0 or 2.1.

This seems to conflict with “ACT Rules are informative — that means they are not required for determining conformance.” stated elsewhere (which is correct).

Here is some wording that we’re used elsewhere to differentiate such information:

  • The WCAG Documents: … The supporting documents directly relate to WCAG guidelines and success criteria. They are not required to meet WCAG; they are “informative” or “non-normative”. … Supplemental guidance goes beyond the requirements of WCAG. It is not required to meet WCAG. Much of the guidance is essential…
  • media resource Some of the guidance below is related to requirements in Web Content Accessibility Guidelines (WCAG)... Other guidance is good practice.

[suggestion] Perhaps this grouping and phrasing would work:

  • Rules for WCAG 2
    The ACT Rules in this section directly relate to WCAG success criteria.
  • Rules beyond WCAG
    The Act Rules below do not directly relate to WCAG success criteria. They relate to other accessibility guidance such as WAI-ARIA or WCAG Techniques.

@shawna-slh
Copy link
Contributor

Ref: Test Tool & Methodology Matrix https://deploy-preview-103--wai-wcag-act-rules.netlify.app/standards-guidelines/act/implementations/

What is the purpose of the page? Who is the audience? What are users trying to accomplish that this page helps them with? How does this relate to the long-standing Eval Tools List ((existing, redesign draft)?

I would need at least “quick and dirty” info above to be able to provide good input. Here are a few thoughts regardless of above.


While I appreciate that “matrix” was the term used in the project proposal, I don’t think this is a matrix, I don’t think matrix communicates what it is, and I don’t think we are bound to using that term.

I think the most accurate title is something like “ACT Rules Implementations”. I seem to recall someone thought that might not be well understood? What if that is part of a longer title? Could have title and subtitle, or long title with short version in the navigation. Also note that we have the Web Accessibility Evaluation Tools List and soon a Digital Accessibility Course List and Accessible Authoring Tools List – so possibly “List” would be good to include? Some brainstorms:

  • title: ACT Rules Implementation in Test Tools and Methodologies
    nav: Implementations in Tools and Methodologies
  • title: ACT Rules Implementation Reports
    subtitle: List of accessibility test tools and methodologies that use ACT Rules
    nav: ACT Rules in Test Tools and Methodologies

[minor] For title, I prefer writing out “and” – because it’s easier to understand and more formal than “&”, and just looks better to me :-). For navigation, OK with “&”, though I think it’s a tad jarring. I don’t feel strongly at all.


[medium] Report column cells missing affordance that the image/icon is clickable. Maybe make it look like a button?


[medium-minor] Why the order:

  • Test Methodologies
  • Semi-automated Test Tools
  • Automated Test Tools

?
I’m guessing Test Methodologies will always have the least number of listings with the least number of consistent rules. And Automated Test Tools will have the most of both. Also, the wording is usually “test tools and methodologies”. Therefore, maybe better to put Automated Test Tools first and Test Methodologies last?


[minor] “WCAG 2.1 all levels” -> “WCAG 2.1 Level A, AA, AAA”
and to match, “WCAG 2.0 Level A & AA” -> “WCAG 2.0 Level A, AA”


[minor] copyedit

The tables on these pages show how many ACT Rules different accessibility test tools and methodologies have consistently implemented. Each implementation links to a report with more details on how rules are implemented. See understanding ACT consistency for details.

… I was going to suggest copy edit – but I ran out of steam, sorry. For now, I’ll just say: consider quotes around ‘consistently implemented’ in the first sentence since that is a term specific to this.


[medium] Add a Tool or Methodology button
It is important that it be clear that we actively invite people to submit implementation reports. I understand that many not will. Yet the perception of the invitation is important. For that reason, I think it would be good to make the invitation strong and easier. On the other Lists, we have a button to submit.


[medium] email contact

… If there are any questions or concerns about the information on these pages, open an issue on GitHub or e-mail [email protected].

Probably better to set up a specific e-mail list that goes to multiple people who are in a position to address it (rather than relying on me to forward it :-).

@SteveALee
Copy link
Contributor

Agree matrix is abstract and better to call out the exact purpose.

@WilcoFiers
Copy link
Collaborator Author

WilcoFiers commented Jun 8, 2022

@shawna-slh, thank you for the review. I believe I've addressed everything that should be addressed. For the future, would you mind using Github's inline comment feature when it comes to comments on specific parts. That way I can address / comment on them one at a time.

There are a couple of comments that I didn't address. Motivation for doing so below:

  • In About page Summary box, leave ‘ACT Rules are informative — that means they are not required for determining conformance to WCAG.’

I don't think that we changed. Am I misunderstanding your comment, or did you miss this?

  • To all rules pages, add: ‘ACT Rules are informative — that means they are not required for determining conformance. The basis for determining conformance to WCAG is the success criteria from the WCAG standard — not the ACT Rules.’ Probably this is best added with heading of ‘ACT Rules are Informative’ at the end of the main conten, right before the ‘Help improve this page’ box. Possibly it would be sufficient in the page footer, before the Rule Identifier.

This used to be in the sidebar. Steve removed this when he updated how the ToC works. I don't know why that decision was made, but I would like to see it reversed. I'll open an issue for this. This is not related to this PR.

The summary was just reworded. The only thing that was removed was the link to different WCAG support materials. I do not think something like that belongs in a summary. It's a summary of the current page after all. There is now a section with related resources which is more extensive than we can reasonably put in a summary.

  • I suggest editing: “This page contains list of ACT Rules to test conformance Web Content Accessibility Guidelines (WCAG), WAI-ARIA and other accessibility practices.” and “…for determining conformance to WCAG or ARIA.”

ACT Rules can not be used to determine conformance. They can be used as part of testing conformance, but they aren't enough to determine conformance. I don't think this suggestion is accurate. It may also come across as contradicting the "they are not required for determining conformance" statement further down the page. Prefer to keep the text as is.

  • [medium-minor] Why the order: Test Methodologies, Semi-automated Test Tools, Automated Test Tools

People often think ACT is all about automated testing. I wanted to draw attention to manual and semi-automated testing by putting them higher on the page. They should be able to get higher numbers then automated tools too, since they're less constraint. This was discussed and agreed on by ACT TF.

  • [minor] copyedit ...

I don't understand the request here.

  • [medium] email contact

I'll open a separate issue for that. This is not specific to this PR.

Copy link
Contributor

@shawna-slh shawna-slh left a comment

Choose a reason for hiding this comment

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

I'm not able to review this again now. I leave it for Daniel.

I just answered questions Daniel had sent me in e-mail for our meeting yesterday that I missed.

I need a review option for:
( ) I appreciate the opportunity to review the latest changes. I didn't get to it. OK to publish without my additional thorough review.
:-)

Copy link
Contributor

@daniel-montalvo daniel-montalvo left a comment

Choose a reason for hiding this comment

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

Looking much better!

In addition to my suggestions, please consider keeping the "Draft" indicator until we have the data from the vendors that are currently listed as "coming soon".

content/implementations.md Outdated Show resolved Hide resolved
content/implementations.md Outdated Show resolved Hide resolved
@WilcoFiers
Copy link
Collaborator Author

Approved on TF today, with no objections.

@WilcoFiers WilcoFiers merged commit cba6171 into master Jun 16, 2022
@WilcoFiers WilcoFiers deleted the layout-work branch June 16, 2022 15:40
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.

7 participants