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

Jump to bottom

Findable Help #1158

Merged
merged 12 commits into from Jul 19, 2020
Merged

Findable Help #1158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c43a918
Findable Help
rachaelbradley Jun 11, 2020
282f760
Index update
rachaelbradley Jun 11, 2020
d2cc0bd
Markup updates
alastc Jun 11, 2020
d621e05
Adding SC text to understanding doc.
alastc Jun 13, 2020
bddbfa6
Missing word & full stop.
alastc Jun 13, 2020
37e5a6a
Missing word.
alastc Jun 13, 2020
08e70f2
Clarification in understanding
rachaelbradley Jun 14, 2020
2b6e82f
Updating links
alastc Jun 15, 2020
a2883a6
Merge branch 'wcag22-findable-help' of https://github.com/w3c/wcag in…
alastc Jun 15, 2020
d80f49e
Finding help: Changes from the CFC thread (#1167)
alastc Jun 24, 2020
e3bc8e7
Prepping for merge
alastc Jul 19, 2020
906e71a
Updating technique number
alastc Jul 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions guidelines/index.html
View file
Open in desktop
Expand Up @@ -325,6 +325,8 @@ <h3>Predictable</h3>
<section data-include="sc/20/consistent-identification.html" data-include-replace="true"></section>

<section data-include="sc/20/change-on-request.html" data-include-replace="true"></section>

<section data-include="sc/22/findable-help.html" data-include-replace="true"></section>

</section>

Expand Down
21 changes: 21 additions & 0 deletions guidelines/sc/22/findable-help.html
View file
Open in desktop
@@ -0,0 +1,21 @@
<section class="sc changed">

<h4>Findable Help</h4>

<p class="conformance-level">A</p>
<p class="change">New</p>

<p>For <a>single page Web applications</a> or any <a>set of Web pages</a>, if one of the following is available,
then access to at least one option is included in the <a>same relative order</a> on each page:</p>

<ul>
<li>Human contact details;</li>
<li>Human contact mechanism;</li>
<li>Self-help option;</li>
<li>A fully automated contact mechanism.</li>
</ul>

<p class="note">Access to help mechanisms may be provided directly on the page, or may be provided via a direct link to a different page containing the information"</p>

</section>

5 changes: 5 additions & 0 deletions guidelines/terms/22/single-page-apps.html
View file
Open in desktop
@@ -0,0 +1,5 @@
<dt class="new" data-lt="single page Web applications"><dfn>Single page Web application</dfn></dt>
<dd class="new">
<p class="change">New</p>
<p>Pages obtained from a single URI that provide navigation which changes the meaning of the Web page</p>
</dd>
60 changes: 60 additions & 0 deletions techniques/general/G220.html
View file
Open in desktop
@@ -0,0 +1,60 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>Provide a contact-us link</title>
<link rel="stylesheet" type="text/css" href="../../css/editors.css"/>
</head>
<body>
<h1>Provide a contact-us link</h1>
<section id="meta">
<h2>Metadata</h2>
<p id="sc">Findable Help</p>
<p id="type">Sufficient</p>
</section>
<section id="applicability">
<h2>Applicability</h2>
<p class="instructions">Technologies that contain links</p>
</section>
<section id="description">
<h2>Description</h2>
<p>The objective of this technique is to provide a mechanism for finding contact details in a consistent location across pages to make it easier for users to find it. The interactive item in the Web page is a link to the contact details page. The programmatic and visual location is consistent on each page in the set of web pages, when viewed within the same size viewport. Activating the link brings users to a Web page with contact details such as a phone number and/or email address.</p>

</section>
<section id="examples">
<h2>Examples</h2>
<section class="example">
<h3> A link at the top of the page</h3>
<p>An on-line job application asks for many types of information from the user, such as their identification number, but they may have several and not know which one to enter. They may need more information from someone that can answer their question when the contextual help provided does not meet their needs. The (for example) sixth link that the user reaches when tabbing through the page is titled "Contact Us". This link is also visually in the same location on each page. Activating the link brings the user to the contact details page. The contact details page has an email address for a company representative or general information inbox which is then shared with appropriate personnel.</p>
</section>
<section class="example">
<h3>A link in the footer region</h3>
<p>A Web page’s footer region contains links repeated on every page in a set of web pages. The visual and programmatic order are consistent when viewed in the same size display. The (example) third link in the footer region is labeled visually and programmatically “Contact Us.” A user activates the link and is brought to the contact details page. The contact details page has an email address for a company representative or general information inbox which is then shared with appropriate personnel.</p>
</section>
</section>
<section id="tests">
<h2>Tests</h2>
<section class="test-procedure">
<h3>Procedure</h3>
<ol>
<li>Determine if this is a single page app or a set of web pages, with blocks of content that are repeated on multiple web pages.</li>
<li>Determine if at least one of the following is included or linked in a consistent location:
<ul>
<li>Human contact details</li>
<li>Human contact mechanism </li>
<li>Self-help option</li>
<li>A fully automated mechanism</li>
</ul>
</li>
<li>Without changing the viewport size, check that the identified help is present on all other web pages within that set of web pages. </li>
</ol>
</section>
</section>
<section id="related">
<h2>Related Techniques</h2>
<ul>
<li>ID</li>
</ul>
</section>

</body>
</html>
152 changes: 152 additions & 0 deletions understanding/22/findable-help.html
View file
Open in desktop
@@ -0,0 +1,152 @@
<!DOCTYPE html>
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="UTF-8"></meta>
<title>Understanding Findable Help</title>
<link rel="stylesheet" type="text/css" href="../../css/editors.css" class="remove"></link>
</head>
<body>
<h1>Understanding Findable Help</h1>

<section id="status" class="advisement">
<h2>Status</h2>
<p>This understanding document is part of the <a href="https://w3c.github.io/wcag/guidelines/22/"><strong>draft</strong> WCAG 2.2 content</a>. It may change or be removed before the final WCAG 2.2 is published.</p>
</section>


<section class="remove">

<h2>Findable Help</h2>
<p>Success criteria text:</p>
<blockquote>
<p class="conformance-level">A</p>

<p>For <a>single page Web applications</a> or any <a>set of Web pages</a>, if one of the following is available, then access to at least one option is included in the <a>same relative order</a> on each page:</p>
<ul>
<li>Human contact details;</li>
<li>Human contact mechanism;</li>
<li>Self-help option;</li>
<li>A fully automated contact mechanism.</li>
</ul>

<p class="note">Access to help mechanisms may be provided directly on the page, or may be provided via a direct link to a different page containing the information"</p>

</blockquote>
<p>Definition of Single page Web applications:</p>
<blockquote>
<p>Pages obtained from a single URI that provide navigation which changes the meaning of the Web page</p>
</blockquote>
</section>

<section id="intent">

<h2>Intent of Findable Help</h2>


<p>The intent of this success criterion is to ensure users can find help for completing tasks on a Web site. This is distinct from interface-level help, such as contextual help, features like spell checkers, and instructional text in a form. </p>

<p>Locating the help mechanism in a consistent location across pages makes it easier for users to find it. For example, when a mechanism or link is located in the header of a Web page, it will be presented in the header of all pages within the set of Web pages.</p>

<p>The location in a smaller viewport may be different than in a larger viewport but the mechanism or link will remain in the same location throughout the size. The location should remain consistent both visually and programmatically.</p>

<p>While it would be best for all sites to offer this type of help, the requirement is for:</p>
<ul>
<li>single page Web applications, or</li>
<li>any set of Web pages with blocks of content that are repeated on multiple Web pages,</li>
</ul>
<p>and is actively supported.</p>

<p>When having problems completing a task on a Web site, people with some types of disabilities may not be able to work through the issue without further help. Issues could include difficulty:
completing a form, or finding a document or page which provides information required to complete a task.</p>

<p>Without help, some users may abandon the task. They may also fail to correctly complete a task, or they may require assistance from people who do not necessarily keep private information secure.</p>

<p>Self help methods beyond the site, such as using internet search to find the contact information for an organization, can be too difficult. Further, the user’s disability may make it more difficult to find the help available (such as a “contact us” link, phone number, or support page) if the information is not present within a few interactions (e.g., displayed in the header, or via a menu). In addition, for some users with disabilities, struggling to complete a task on a site may cause additional cognitive challenges when searching for help within the site.</p>

<p>When a user is quickly able to find help, they are able to complete the task even if they encounter challenges.</p>

<p>At least one of the following mechanisms to get help should be included:</p>
<ul>
<li>Human contact details such as a phone number, email address, hours of operation.</li>
<li>Human contact mechanism such as a messaging system, chat client, contact form, social media channel.</li>
<li>Self-help option such as an up-to-date Frequently Asked Questions, How Do I page, Support page.</li>
<li>A fully automated contact mechanism such as a chatbot.</li>
</ul>

<p>The human contact details should enable the user to connect with the organization or the part of the organization responsible for the content. For example, an online jobs / recruitment portal should provide a contact method for the team that supports the recruitment portal and not a catch-all for the entire company. Each layer of contact added prolongs the time before the user will receive help.</p>

<p>The human contact mechanism enables a person to express what they are looking for using their own words. For some with cognitive disabilities, this may be the best way for them to find an answer to their problem.</p>

<p>For pages for which no human support is available, a self-help option should say that no human support is available. Self-help options should go beyond allowing the user to search within the site. Contextual help is still recommended (See SC 3.3.5 for more information) but a self-help option should provide a single location that makes it easier for people with cognitive disabilities to understand what help is available without having to hunt for it. While some people may easily be able to identify that no support would be available for a particular type of Web site, this may not be apparent to some users with disabilities.</p>

<p>If a chatbot is provided, it should meet other WCAG success criteria for your conformance level. Chatbots which work more effectively for everyone, and particularly for people with cognitive disabilities should:</p>

<ul>
<li>recognize misspelled words,</li>
<li>provide human contact details if the chatbot is unable to provide a satisfactory response after 3 attempts, and</li>
<li>be dismissed with a single interaction, and recalled using a link or button.</li>
</ul>

<p>It is not the intent of this Success Criteria to require authors to provide help information on PDFs or other static documents that may be available for viewing/download from the Web pages. It is also not the intent to require contact information if:</p>
<ul>
<li>A Web site is not supported,</li>
<li>Content is archived, or </li>
<li>When finding help would invalidate the activity such as in a testing situation. </li>
</ul>

<p>It is also not the intent of this Success Criteria to require a human be available at all times. If the human contact is not available during certain hours or certain days, information should be provided so the user can tell when it will be available. </p>
</section>

<section id="benefits">
<h2>Benefits of Findable Help</h2>

<ul>
<li>This Success Criterion helps people who may have difficulty locating help that is not part of the page they are using. Ensuring they can connect with help allows them to complete the task.</li>
<li>When a user can easily find help for their specific questions, they are more successful completing tasks.</li>
<li>Users that experience cognitive fatigue or cognitive shut down will be able to reserve their energy for the task, instead of using it to find support.</li>
<li>Enabling users (especially those with cognitive disabilities) to find solutions while expressing their question using their own words increases their chances of success for completing a task.</li>
</ul>

</section>

<section id="examples">
<h2>Examples of Findable Help</h2>

<ul>
<li>On-line job application - Some of the application questions may be hard for new job seekers to understand even after reading the contextual help. For example, the form may request their identification number, but they may have several and not know which one to enter. Easily findable contact information will enable them to use phone or email so they can get an answer to their question.</li>
<li>Medical appointment scheduling form - When the service a patient is trying to book is not easily findable within the interface, they may need human help. A built-in messaging option (chat client) enables them to quickly interact with a staff person that can help, without requiring them to manage a second interface.</li>
<li>Finding a specific policy or procedure - An employee who needs to complete a work task may have difficulty locating the specific policy or procedure document on their employer’s Web site. A How Do I page may include the information that enables them to independently complete this task.</li>
</ul>

</section>


<section id="techniques">
<h2>Techniques for Findable Help</h2>


<section id="sufficient">
<h3>Sufficient Techniques for Findable Help</h3>
<ol>
<li><a href="../../techniques/general/G220" class="general">Provide a contact-us link</a></li>
</ol>
</section>

<section id="advisory">
<h3>Additional Techniques (Advisory) for Findable Help</h3>

</section>

<section id="failure">
<h3>Failures for Findable Help</h3>

<ul>
<li>Inconsistent Help Location
</li>
</ul>
</section>

</section>

</body>
</html>