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 terminology: ACT Rules -> WCAG 2 Test Rules ? #56

Open
shawna-slh opened this issue Aug 5, 2021 · 15 comments
Open

update terminology: ACT Rules -> WCAG 2 Test Rules ? #56

shawna-slh opened this issue Aug 5, 2021 · 15 comments
Assignees

Comments

@shawna-slh
Copy link
Contributor

shawna-slh commented Aug 5, 2021

Background

Previously these were called Accessibility Conformance Testing (ACT) Rules.

I understand that AG chose to use "Test Rules" where they are listed in Techniques and Understanding (example)

Understanding Test Rules for WCAG Success Criteria uses "Test Rules for WCAG Success Criteria", "ACT Rules for WCAG 2", "ACT Rules".

About WCAG ACT Rules uses "WCAG ACT Rules", "Test Rules for WCAG 2", "Test Rules".

I would like for us to settle on current terminology and then update the docs to be consistent.

Here is a straw proposal:

  • Leave the format name Accessibility Conformance Testing (ACT) Rules Format
  • Leave the group names Accessibility Conformance Testing (ACT) Task Force and ACT Rules Community Group
  • ok to internally and informally refer to them as ACT Rules
  • start calling the rules themselves "WCAG 2 Test Rules" and for short "Test Rules" or "Rules" — for example:
    • Techniques and Understanding (example): "Test Rules" (as it currently is)
    • banner in redesign: "WCAG 2 Test Rules"
    • navigation in redesign: "All Rules", "About Rules"
    • About Rules page in redesign: h1 "About WCAG 2 Test Rules", first sentence "WCAG 2 Test Rules", other headings "Test Rules", other sentences "Test Rules" or "Rules"
    • About Rules page in redesign: h1 "About WCAG 2 Test Rules", first sentence "WCAG 2 Test Rules", other headings "Test Rules", other sentences "Test Rules" or "Rules"
    • All Rules page in redesign: h1 "All WCAG 2 Test Rules", h2s "Finalized Test Rules" (or "Published Test Rules" or "Completed Test Rules" or ?) and "Proposed Test Rules"

To: @wilco and @kendoj CC: @nitedog @hidde @daniel-montalvo

@shawna-slh shawna-slh changed the title update terminology: ACT Rules -> WCAG Test Rules ? update terminology: ACT Rules -> WCAG 2 Test Rules ? Aug 5, 2021
@shawna-slh shawna-slh mentioned this issue Aug 5, 2021
13 tasks
@kengdoj
Copy link
Contributor

kengdoj commented Aug 10, 2021

Hi @shawna-slh, I'm @kengdoj on github. Feel free to assign me. I couldn't self-assign.

@WilcoFiers
Copy link
Collaborator

I'm opening PRs to fix all of these, except for adding a "Finalized" / "Published" preface. I don't think we should add that. A rule is either a "Proposed Test Rule" or it is a "Test Rule".

@shawna-slh
Copy link
Contributor Author

... except for adding a "Finalized" / "Published" preface. I don't think we should add that. A rule is either a "Proposed Test Rule" or it is a "Test Rule".

I don't have strong opinions either way. (I think Shadi suggested it.)

I'm OK with whatever the group decides.

@shawna-slh
Copy link
Contributor Author

shawna-slh commented Sep 14, 2021

Hi @WilcoFiers Just a few little bugs:

  • Friendly reminder that you noted that overall banner still needs to be updated from "WCAG 2: ACT Rules" to "WCAG 2 Test Rules"
  • I also see that https://deploy-preview-51--wcag-act-rules.netlify.app/standards-guidelines/act/rules/ still has h1 "WCAG 2 Test Rules" instead of h1 "All WCAG 2 Test Rules" (I imagine that just got lost in all the other little changes. I think it’s kinda important so the h1 starts out with the same word as the navigation link ("All"), to give user confidence that they are on the right page. Also, good to differentiate from the header text. If you have other thoughts, I’m happy to discuss.)
  • On the All WCAG 2 Test Rules page, the h2s both start with "List of". I’m not sure if that is on purpose, or just not yet updated? It seems "List of" is not needed, as they are clearly lists. And it decreases understandability by not frontloading the unique information. You said:

A rule is either a "Proposed Test Rule" or it is a "Test Rule".

Would you be comfortable using that wording for the the h2s? I think that simple wording is probably best. (While just "Test Rules" & "Proposed Test Rules" is my preference, these also seems fine: "Test Rule List" & "Proposed Test Rule List" or "WCAG 2 Test Rules" & "Proposed WCAG 2 Test Rules" or "WCAG 2 Test Rule List" & "Proposed WCAG 2 Test Rule List")

  • A couple little grammar things I see: "These Test Rules have been approved by the Accessibility Guidelines Working Group and is fully implemented in at least one evaluation tools or methodologies.” at minimum, change “is fully” to “are fully” and change plurals to singular. I suggest even simpler language:

These Test Rules are approved by the Accessibility Guidelines Working Group (AGWG). They are fully implemented in at least one evaluation tool or methodology.

  • (and while you're at it, you could simplify the proposed sentences: “The following is a list of proposed test rules. These will be moved to the list of published test rules when they have one or more implementations.” to:

Proposed test rules will be published when they have at least one implementation and are approved by the AGWG.

or

Proposed test rules are approved by the AGWG and will be published when they have at least one implementation.

@WilcoFiers
Copy link
Collaborator

WilcoFiers commented Sep 15, 2021

I've updated the index page as you suggested, see: 6d72413
I submitted a fix for the title before I went on vacation. It just needs to be merged: w3c/wai-website-theme#34

@shawna-slh
Copy link
Contributor Author

shawna-slh commented Sep 15, 2021

HI @WilcoFiers and @daniel-montalvo

It looks like some things missed. Would you both please do a thorough QA check. Thanks.

@shawna-slh
Copy link
Contributor Author

It just needs to be merged: w3c/wai-website-theme#34

I assigned it to Hidde to review and merge. @hidde please let me know if you want anything from me on that.

@daniel-montalvo
Copy link
Contributor

Hey , @shawna-slh @WilcoFiers

I took a pass at these two pages.

https://deploy-preview-51--wcag-act-rules.netlify.app/standards-guidelines/act/rules/

Changes in
https://github.com/w3c/wcag-act-rules/tree/01b39d3cf210491d23be6db7ff28f62a312b8cf9
and
https://github.com/w3c/wcag-act-rules/tree/01b39d3cf210491d23be6db7ff28f62a312b8cf9

  • Simplified sentences.
  • Changed wrong plurals.
  • Decided not to change "have been approved" to "are approved". The approval does not happen in recurring pattern. I am hesitant that "are approved" suggests the approval is renewed or something like that.

https://deploy-preview-51--wcag-act-rules.netlify.app/standards-guidelines/act/rules/about/

Changes in
6467021

  • Change "they" to "The rules" to avoid ambiguity.
  • Changed "Test Rule Implementations" to "Implementations of Test Rules" for front-loading main topic discussed in the section and for better grammar.
  • Changed "such as" to "for example" to better align to EOWG Style Guide.

WilcoFiers added a commit that referenced this issue Sep 20, 2021
…oposed rules (#51)

* Use supporting document template

* Remove layout and set metadata to be used by wai-website-theme provided layout

Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>

* Remove spaces

Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>

* Make links and refs consistent

* Use standalone_resource as template name

* Remove “supporting_doc_name_sub“, add 2.1 for consistency

Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>

* Use new names for variables in line with wai-website-theme

* Fix variable name

* Add new keys that template supports

Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>

* Set type to false

Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>

* Reomove redundant content

Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>

* Use Test Rule as type of guidance, say WCAG 2

Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>

* Add note and link to “test” test rule,  make atomic default

Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>

* Update rules to the new format

* Add implementation table to accepted rules

* Proposed rule implementation data

* Update about.md

* Fix definition links

* Update content/about.md

Co-authored-by: Wilco Fiers <WilcoFiers@users.noreply.github.com>

* Update content/about.md

Co-authored-by: Wilco Fiers <WilcoFiers@users.noreply.github.com>

* Add example "open in new tab" rule

* Editorial updates to about & index

* put acknowledgments in the footer

* empty

* empty footers

* update footer of accepted rules

* Update index h1

* Namespace patterns

Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>

* Leave change to lockfile out of PR

Signed-off-by: Hidde de Vries <hidde@hiddedevries.nl>

* Tweak index headings & text

* Fixing wrong plurals addressing #56 comments

* Grammar and language issues

* Split into two sentences

Co-authored-by: Wilco Fiers <wilco.fiers@deque.com>
Co-authored-by: Shadi Abou-Zahra <shadi@w3.org>
Co-authored-by: Wilco Fiers <WilcoFiers@users.noreply.github.com>
Co-authored-by: daniel-montalvo <dmontalvo@w3.org>
@shawna-slh
Copy link
Contributor Author

shawna-slh commented Mar 12, 2022

Hi @WilcoFiers @daniel-montalvo others

Daniel pointed me to the Rules name minutes from 24 February.

Note that I did not instigate a change from "ACT Rules". It was my understanding that when incorporating them into the Understanding WCAG documents, AG requested they be called "Test Rules".

I don't have any strong opinions on this. I personally still call them "ACT Rules" out of habit. :-/

I encourage you to consider how the terminology will work best for new users going forward, as well as for those familiar with "ACT Rules". And in the different places they are referred to.

I welcome additional discussion, and/or Pull Requests for edits that are agreed upon by Rules folks, AG, and other interested parties.

@nitedog
Copy link
Contributor

nitedog commented Mar 14, 2022

It is also my recollection that the AGWG leadership disliked "ACT Rules", and that after quite some discussion we ended up with "WCAG 2 Test Rules" and just "Test Rules" for shorthand in the Understanding WCAG 2 and Techniques for WCAG 2 documents.

@WilcoFiers
Copy link
Collaborator

Thanks for the input @nitedog. I did not know that (either that, or I forgot). I'll bring this to the AG chairs.

Over the last year I've started to hear of people talk about ACT outside of people directly involved with ACT or AG. The term is starting to become known. I think there is value in us continuing to use it. Especially since there is a growing set of ARIA rules as well.

@shawna-slh
Copy link
Contributor Author

Especially since there is a growing set of ARIA rules as well.

hummm, Do we want to have parent "ACT Rules" then underneath that "WCAG 2 Test Rules" and "ARIA Test Rules"?

I am a little uncomfortable with ARIA test rules being under what is called "WCAG 2 Test Rules" as it reinforces the misunderstanding that ARIA is required for WCAG.

@WilcoFiers
Copy link
Collaborator

Yes, that's exactly what I'm thinking. "ACT Rules" is the parent, and within that is a set of "WCAG 2 Test Rules" and "ARIA Test Rules".

@shawna-slh
Copy link
Contributor Author

I was thinking it would be nice to group them even more - and was thinking about the Techniques categories (CSS, HTML, script, etc.) -- then remembered that we do have an ARIA category in "Techniques for WCAG".

@WilcoFiers
Copy link
Collaborator

I opened a PR to make the changes I've been thinking about:
#103

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

No branches or pull requests

5 participants