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.

Sign up for GitHub

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 3.3.2 Labels or Instructions Understanding Doc #4056

Closed
wants to merge 1 commit into from
Closed

Update 3.3.2 Labels or Instructions Understanding Doc #4056

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions understanding/20/labels-or-instructions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ <h1>Understanding Labels or Instructions</h1>
<h2>In brief</h2>
<dl>
<dt>Goal</dt><dd>Users know what information to enter.</dd>
<dt>What to do</dt><dd>Provide labels or instructions for inputs.</dd>
<dt>What to do</dt><dd>Provide accurate and descriptive labels or instructions for inputs.</dd>
<dt>Why it's important</dt><dd>Everyone, especially those with cognitive disabilities, will know how to respond.</dd>
</dl>

Expand All @@ -21,29 +21,29 @@ <h2>In brief</h2>
<section id="intent">
<h2>Intent of Labels or Instructions</h2>

<p>The intent of this Success Criterion is to have content authors present instructions
or labels that identify the controls in a form so that users know what input data
<p>The intent of this Success Criterion is to have content authors present accurate instructions
Copy link
Member

Choose a reason for hiding this comment

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

i understand your goal of making it clear that 3.3.2 should include making sure the labels are both present and meaningful - thus making 2.4.6 less meaningful - but i don't think just inserting the word 'accurate' (or its synonyms) whenever possible is necessary.

i'd recommend this sentence either insert "accurate" prior to 'instructions', or "clearly" / "concisely" prior to 'identify'.

The next sentence again adds "accurate and descriptive", and the sentence after that adds "accurately" (i don't find this particular addition necessary. we can cut this down.

or labels that precisely and clearly identify the controls in a form so that users know what input data
is expected. In the case of radio buttons, checkboxes, comboboxes, or similar controls
that provide users with options, each option must have an appropriate label so that
that provide users with options, each option must have an accurate and descriptive label so that
users know what they are actually selecting.
Instructions or labels may also specify data formats for data entry fields, especially
Instructions or labels may also accurately specify data formats for data entry fields, especially
Copy link
Member

Choose a reason for hiding this comment

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

as mentioned in my previous comment, this seems an unnecessary add.

Suggested change
Instructions or labels may also accurately specify data formats for data entry fields, especially
Instructions or labels may also specify data formats for data entry fields, especially

if they are out of the customary formats or if there are specific rules for correct
input. Content authors may also choose to make such instructions available to users
only when the individual control has focus especially when instructions are long and
verbose.
</p>

<p>The intent of this Success Criterion is not to clutter the page with unnecessary information
but to provide important cues and instructions that will benefit people with disabilities.
but to provide accurate and essential cues and instructions that will benefit people with disabilities.
Copy link
Member

Choose a reason for hiding this comment

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

why 'essential' here when all other 'accurate and ' instances say 'descriptive'.

Maybe just say accurate? or just essential (i prefer this since it implies accuracy without having to use the word again)

Too much information or instruction can be just as harmful as too little.
The goal is to make certain that enough information is provided for the user to accomplish
The goal is to make certain that enough accurate information is provided for the user to accomplish
the task without undue confusion or navigation.
</p>

<p>This Success Criterion does not require that labels or instructions be correctly marked up,
identified, or associated with their respective controls - this aspect is covered separately by
<a href="info-and-relationships">1.3.1: Info and Relationships</a>. It is possible for content
to pass this Success Criterion (providing relevant labels and instructions) while failing
to pass this Success Criterion (providing relevant, accurate labels and instructions) while failing
Copy link
Member

Choose a reason for hiding this comment

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

is this not redundant? i can't think of a situation where a relevant label or instruction is not implicitly accurate?

Success Criterion 1.3.1 (if the labels or instructions aren't correctly marked up, identified, or associated).
</p>
<p>Further, this Success Criterion does not take into consideration whether or not alternative methods of
Expand All @@ -56,9 +56,7 @@ <h2>Intent of Labels or Instructions</h2>
<p>This Success Criterion does not apply to links or other controls (such as an expand/collapse widget, or similar
interactive components) that are not associated with data entry.
</p>
<p>While this Success Criterion requires that controls and inputs have labels or instructions, whether or
not labels (if used) are sufficiently clear or descriptive is covered separately by
<a href="headings-and-labels">2.4.6: Headings and Labels</a>.
<p>While this Success Criterion requires that controls and inputs have labels or instructions, it is crucial that these labels or instructions are not only present but also accurate. The clarity and descriptiveness of labels are further addressed by <a href="headings-and-labels">2.4.6: Headings and Labels</a>.
Copy link
Member

Choose a reason for hiding this comment

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

Can one have an accurate (and descriptive) label, but also fail heading and labels? IMO, these additions make the 'label' part of headings and labels useless. I'm looking to understand how that's not the case.

Looking at the two docs together, there is no 'further addressing' in 2.4.6. Rather, 2.4.6 is rather concise/brief in the need for descriptive and sufficiently clear labels (and headings). 2.4.6's understanding doc seems to actually spend more time identifying what it doesn't cover than what it does :)

The benefits and examples already repeated content in this doc, but now this doc is more focused on the accuracy of the labels than the Headings and Labels doc is.

In other words, telling people accuracy of labels is further addressed in 2.4.6 is unfortunately false based on the current text of that document. Everything that document had to offer on label accuracy is essentially now here (and arguably more descriptive to boot).

So, I don't see how this update can be made if not flat out acknowledging that since accuracy of labels would be necessary for 3.3.2, then 2.4.6 is automatically met?

Maybe this can somehow be hair split into indicating that 3.3.2 label accuracy applies specifically to form fields, but more general instances of descriptive 'labels' fall under 2.4.6? I'm spit balling here to try and see how this PR can be accepted while not gutting half of the other SC's usefulness.

I just think some sort of clarification in 2.4.6 likely also needs to happen, otherwise this doc will say to go look at 2.4.6, and then that doc will barely repeat what's here, and say to go back to 3.3.2 for more info.

</p>

</section>
Expand All @@ -68,12 +66,12 @@ <h2>Benefits of Labels or Instructions</h2>

<ul>

<li>Providing labels and instructions (including examples of expected
<li>Providing accurate labels and instructions (including examples of expected
data formats) helps all users - but particularly those with cognitive, language, and learning
disabilities - to enter information correctly.
</li>

<li>Providing labels and instructions (including identification of required
<li>Providing accurate labels and instructions (including identification of required
fields) can prevent users from making incomplete or incorrect form submissions, which prevents
users from having to navigate once more through a page/form in order to fix submission errors.
</li>
Expand All @@ -97,8 +95,8 @@ <h2>Examples of Labels or Instructions</h2>
</li>

<li>To enter their name, users are provided with two separate text fields. Rather than
having a single label "Name" (which would appear to leave the second text field unlabelled),
each field is given an explicit label - "Given Name" and "Family Name".
having a single, imprecise label "Name" (which would appear to leave the second text field unlabelled),
each field is given an explicit and accurate label - "Given Name" and "Family Name". This accurate labeling helps users understand where to input their first and last names, reducing confusion and ensuring correct data entry.
Copy link
Member

Choose a reason for hiding this comment

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

"and accurate" is an unnecessary add here, since the examples of "Given Name" and "Family Name" implicitly demonstrate they are more "accurate". Again, immediately following on with a sentence that also starts with reiterating the on the "accurate labeling" is enough.

Suggested change
each field is given an explicit and accurate label - "Given Name" and "Family Name". This accurate labeling helps users understand where to input their first and last names, reducing confusion and ensuring correct data entry.
each field is given an explicit label - "Given Name" and "Family Name". This more accurate labeling helps users understand the purpose of each field, decreasing the possibility of unnecessary mistakes.

is it worth acknowledging the fact that the headings and labels mention of this example, as well as the mention of it on g131 say 'first name' and 'last name'?

should this update to match those? or those update to match this?

</li>

<li>A U.S. phone number separates the area code, exchange, and number into three fields.
Expand Down