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

Shortening "Guidance for..." section headings #238

Closed
maryjom opened this issue Oct 10, 2023 · 5 comments
Closed

Shortening "Guidance for..." section headings #238

maryjom opened this issue Oct 10, 2023 · 5 comments

Comments

@maryjom
Copy link
Contributor

maryjom commented Oct 10, 2023

The guidance headings in WCAG2ICT are too long and can be rephrased more succinctly. Note: If/when we change the headings, we've also got to update the in-document links to the sections, as the links also change due to the markdown. Will also need to modify the scripting that does numbers on notes and examples as it is keying off of the text "Guidance when Applying"

Suggest changing the heading:

Guidance When Applying whatever it is to Non-Web Documents and Software

to instead be something like this:

Applying whatever it is to Non-Web Documents and Software

Up for debate is whether we include the verbiage "Success Criterion", "Guideline", etc. in the heading. IMO, if we simply give the number or give the number and the name of the thing, it is pretty clear. Examples below are variations we could choose from:


For Principles:

Applying 1 Perceivable to Non-web Documents and Software or

Applying Principle 1 Perceivable to Non-web Documents and Software or

Applying 1 Perceivable Principle to Non-web Documents and Software


For Guidelines:

Applying 1.1 Text Alternatives to Non-web Documents and Software or

Applying Guideline 1.1 Text Alternatives to Non-web Documents and Software or

Applying 1.1 Text Alternatives Guideline to Non-web Documents and Software


For Success Criteria - note also the proposed addition of the SC short name in the heading per Issue #223 :

Applying 1.1.1 Non-text Contrast to Non-web Documents and Software or
Applying Success Criterion 1.1.1 Non-text Contrast to Non-web Documents and Software or
Applying 1.1.1 Non-text Contrast Success Criterion to Non-web Documents and Software

For term definitions:

Applying “accessibility supported” to Non-Web Documents and Software

@pday1
Copy link
Contributor

pday1 commented Oct 11, 2023

Looks good to me. I personally find the first option in the list to be the least clumsy; namely
Applying 1.1.1 Non-text Contrast to Non-web Documents and Software

@olivia-hogan-stark
Copy link

+1 to Phil. I think the best choice is the first option, which excludes "Principle," "Guideline," and "Success Criteria." Reviewing the actual document and considering the other text and context surrounding these section headings, I find their inclusion repetitive and unnecessary.

@mapluke
Copy link

mapluke commented Oct 11, 2023

I am not very convinced of the need to shorten the titles. It is possible that those applying WCAG to software and documents may be less familiar with the layers of WCAG guidance, so seeing these listed in the titles may help to familiarize them with the important WCAG concepts.

@maryjom
Copy link
Contributor Author

maryjom commented Oct 12, 2023

At the 12 October meeting we decided the following:

  • For principles use: Applying Principle 1 Perceivable to Non-web Documents and Software
  • For guidelines use: Applying Guideline 1.1 Text Alternatives to Non-web Documents and Software
  • For Success Criteria use: Applying SC 1.1.1 Non-text Content to Non-web Documents and Software
  • For definitions use: Applying “accessibility supported” to Non-Web Documents and Software

We'll have to make adjustments to the links and potentially also the scripting to ensure the document builds correctly.

@maryjom
Copy link
Contributor Author

maryjom commented Oct 20, 2023

Closing this issue as it has been resolved.

@maryjom maryjom closed this as completed Oct 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

4 participants