From c43a91892c303d7989bcb983d97854da9efdcda9 Mon Sep 17 00:00:00 2001 From: rachaelbradley Date: Thu, 11 Jun 2020 15:29:27 -0400 Subject: [PATCH 01/11] Findable Help --- guidelines/sc/22/findable-help.html | 17 +++ guidelines/terms/22/single-page-apps.html | 6 + techniques/general/FindableHelp.html | 59 +++++++++ understanding/22/findable-help.html | 138 ++++++++++++++++++++++ 4 files changed, 220 insertions(+) create mode 100644 guidelines/sc/22/findable-help.html create mode 100644 guidelines/terms/22/single-page-apps.html create mode 100644 techniques/general/FindableHelp.html create mode 100644 understanding/22/findable-help.html diff --git a/guidelines/sc/22/findable-help.html b/guidelines/sc/22/findable-help.html new file mode 100644 index 0000000000..6f9520ca39 --- /dev/null +++ b/guidelines/sc/22/findable-help.html @@ -0,0 +1,17 @@ +
+ +

Findable Help

+ +

A

+

New

+ +

For single page apps or any set of web pages with blocks of content that are repeated on multiple web pages, if one of the following is available, + then at least one of the following is included or linked in a consistent location:

+ + + + +
\ No newline at end of file diff --git a/guidelines/terms/22/single-page-apps.html b/guidelines/terms/22/single-page-apps.html new file mode 100644 index 0000000000..0ec2c6354c --- /dev/null +++ b/guidelines/terms/22/single-page-apps.html @@ -0,0 +1,6 @@ +
Single page apps
+
+

New

+

After the first page load, all subsequent page and content changes are handled internally by the application. +

+
\ No newline at end of file diff --git a/techniques/general/FindableHelp.html b/techniques/general/FindableHelp.html new file mode 100644 index 0000000000..c3fc228f89 --- /dev/null +++ b/techniques/general/FindableHelp.html @@ -0,0 +1,59 @@ + + + + Contact Details + + + +

Contact Us Link

+
+

Metadata

+

Findable Help

+

Sufficient

+
+
+

Applicability

+

Technologies that contain links

+
+
+

Description

+

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.

+ +
+
+

Examples

+
+

A link at the top of the page

+

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.

+
+
+

A link in the footer region

+

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.

+
+
+
+

Tests

+
+

Procedure

+
    +
  1. 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.
    2. +
  2. Determine if at least one of the following is included or linked in a consistent location:
    3. +
    • Human contact details
      • +
    • Human contact mechanism
      • +
    • Self-help option
      • +
    • A fully automated mechanism
    +
  3. Without changing the viewport size, check that the identified help is present on all other web pages within that set of web pages.
    4. +
+ + + +
+ + + + diff --git a/understanding/22/findable-help.html b/understanding/22/findable-help.html new file mode 100644 index 0000000000..df6b288ecb --- /dev/null +++ b/understanding/22/findable-help.html @@ -0,0 +1,138 @@ + + + + + Understanding Findable Help + + + +

Findable Help

+ +
+

Status

+

This understanding document is part of the draft WCAG 2.2 content. It may change or be removed before the final WCAG 2.2 is published.

+
+ + +
+ +

Findable Help

+
+

A

+ +

For single page apps or any set of web pages with blocks of content that are repeated on multiple web pages, if one of the following is available, + then at least one of the following is included or linked in a consistent location:

+ +
  • Human contact details
    • +
  • Human contact mechanism
    • +
  • Self-help option
    • +
  • A fully automated mechanism
+
+
+ +
+ +

Intent of Focus Visible (Enhanced)

+ + +

The intent of this proposed Success Criteria is to ensure users can find help for completing tasks on a website. This is distinct from interface-level help such as contextual help, features like spell checkers, and instructional text in a form.

+ +

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 webpages.

+ +

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.

+ +

While it would be best for all sites to offer this type of help, the requirement is for single page apps, or any set of web pages with blocks of content that are repeated on multiple web pages, and is actively supported. + +

When having problems completing a task on a website, 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.

+ +

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

+ +

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.

+ +

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

+ +

At least one of the following mechanisms to get help should be included:

+
  • Human contact details such as a phone number, email address, hours of operation;
    • +
  • Human contact mechanism such as a messaging system, chat client, contact form, social media channel;
    • +
  • Self-help option such as an up-to-date Frequently Asked Questions, How Do I page, Support page; or
    • +
  • A fully automated chatbot.
+ +

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.

+ +

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.

+ +

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 website, this may not be apparent to some users with disabilities.

+ +

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:

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

    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:

    +
    • A website is not supported,
      • +
    • Content is archived, or
      • +
    • When finding help would invalidate the activity such as in a testing situation.
    + +

    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.

    + + +
    +

    Benefits of Findable Help

    + +
      +
    • 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.
      • +
    • When a user can easily find help for their specific questions, they are more successful completing tasks.
      • +
    • 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.
      • +
    • 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.
      • +
    + +
    + +
    +

    Examples of Focus Visible

    + +
      +
    • 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.
      • +
    • 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.
      • +
    • 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 website. A How Do I page may include the information that enables them to independently complete this task.
      • +
    + +
    + + +
    +

    Techniques for Focus Visible

    + + +
    +

    Sufficient Techniques for Focus Visible (Enhanced)

    + + +
      +
    1. + Contact Us Link +
      2. + +
    + +
    + +
    +

    Additional Techniques (Advisory) for Focus Visible

    + +
    + +
    +

    Failures for Focus Visible

    + +
      +
    • Inconsistent Help Location +
      • +
    +
    + +
    + + + From 282f7608455d0dcdb686cc80995a7beace8fbaef Mon Sep 17 00:00:00 2001 From: rachaelbradley Date: Thu, 11 Jun 2020 15:47:27 -0400 Subject: [PATCH 02/11] Index update --- guidelines/index.html | 2 ++ guidelines/sc/22/findable-help.html | 3 ++- guidelines/terms/22/single-page-apps.html | 2 +- understanding/22/findable-help.html | 2 +- 4 files changed, 6 insertions(+), 3 deletions(-) diff --git a/guidelines/index.html b/guidelines/index.html index e528c11cc3..dcedb7beac 100644 --- a/guidelines/index.html +++ b/guidelines/index.html @@ -325,6 +325,8 @@

    Predictable

    + +
diff --git a/guidelines/sc/22/findable-help.html b/guidelines/sc/22/findable-help.html index 6f9520ca39..e41f9c0a3c 100644 --- a/guidelines/sc/22/findable-help.html +++ b/guidelines/sc/22/findable-help.html @@ -14,4 +14,5 @@

Findable Help

  • A fully automated mechanism
    • -
    \ No newline at end of file + + \ No newline at end of file diff --git a/guidelines/terms/22/single-page-apps.html b/guidelines/terms/22/single-page-apps.html index 0ec2c6354c..dc45244cc6 100644 --- a/guidelines/terms/22/single-page-apps.html +++ b/guidelines/terms/22/single-page-apps.html @@ -3,4 +3,4 @@

    New

    After the first page load, all subsequent page and content changes are handled internally by the application.

    - \ No newline at end of file + diff --git a/understanding/22/findable-help.html b/understanding/22/findable-help.html index df6b288ecb..52cb023044 100644 --- a/understanding/22/findable-help.html +++ b/understanding/22/findable-help.html @@ -6,7 +6,7 @@ -

    Findable Help

    +

    3.2.6 Findable Help

    Status

    From d2cc0bdf3eb2a695602ce170acd9b6ced9e40afa Mon Sep 17 00:00:00 2001 From: Alastair Campbell Date: Fri, 12 Jun 2020 00:11:59 +0100 Subject: [PATCH 03/11] Markup updates --- techniques/general/FindableHelp.html | 21 ++++--- understanding/22/findable-help.html | 91 ++++++++++++++-------------- 2 files changed, 57 insertions(+), 55 deletions(-) diff --git a/techniques/general/FindableHelp.html b/techniques/general/FindableHelp.html index c3fc228f89..ebe013b3b4 100644 --- a/techniques/general/FindableHelp.html +++ b/techniques/general/FindableHelp.html @@ -1,11 +1,11 @@ - Contact Details + Provide a contact-us link -

    Contact Us Link

    +

    Provide a contact-us link

    Metadata

    Findable Help

    @@ -37,17 +37,18 @@

    Tests

    Procedure

    1. 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.
      2. -
    2. Determine if at least one of the following is included or linked in a consistent location:
      3. -
      • Human contact details
        • +
      • Determine if at least one of the following is included or linked in a consistent location: +
          +
        • Human contact details
        • Human contact mechanism
        • Self-help option
          • -
        • A fully automated mechanism
        +
      • A fully automated mechanism
        • +
      +
    3. Without changing the viewport size, check that the identified help is present on all other web pages within that set of web pages.
      4. -
    - - - -
    + +
    + - \ No newline at end of file + diff --git a/guidelines/terms/22/single-page-apps.html b/guidelines/terms/22/single-page-apps.html index dc45244cc6..3c6e34dfea 100644 --- a/guidelines/terms/22/single-page-apps.html +++ b/guidelines/terms/22/single-page-apps.html @@ -1,6 +1,5 @@ -
    Single page apps
    +
    Single page Web application

    New

    -

    After the first page load, all subsequent page and content changes are handled internally by the application. -

    +

    Pages obtained from a single URI that provide navigation which changes the meaning of the Web page

    diff --git a/understanding/22/findable-help.html b/understanding/22/findable-help.html index 795a70323e..d4719b9977 100644 --- a/understanding/22/findable-help.html +++ b/understanding/22/findable-help.html @@ -21,17 +21,20 @@

    Findable Help

    A

    -

    For single page apps or any set of web pages with blocks of content that are repeated on multiple web pages, if one of the following is available, then at least one of the following is included or linked in a consistent location:

    - +

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

    + + +

    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"

    +
    -

    Definition of single page apps:

    +

    Definition of Single page Web applications:

    -

    After the first page load, all subsequent page and content changes are handled internally by the application.

    +

    Pages obtained from a single URI that provide navigation which changes the meaning of the Web page

    @@ -40,36 +43,41 @@

    Findable Help

    Intent of Findable Help

    -

    The intent of this proposed Success Criteria is to ensure users can find help for completing tasks on a website. This is distinct from interface-level help such as contextual help, features like spell checkers, and instructional text in a form.

    +

    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.

    -

    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 webpages.

    +

    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.

    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.

    -

    While it would be best for all sites to offer this type of help, the requirement is for single page apps, or any set of web pages with blocks of content that are repeated on multiple web pages, and is actively supported.

    - -

    When having problems completing a task on a website, people with some types of disabilities may not be able to work through the issue without further help. Issues could include difficulty: +

    While it would be best for all sites to offer this type of help, the requirement is for:

    + +

    and is actively supported.

    + +

    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.

    -

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

    +

    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.

    -

    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.

    +

    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.

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

    At least one of the following mechanisms to get help should be included:

    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.

    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.

    -

    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 website, this may not be apparent to some users with disabilities.

    +

    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.

    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:

    @@ -79,9 +87,9 @@

    Intent of Findable Help

  • be dismissed with a single interaction, and recalled using a link or button.
    • -

    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:

    +

    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:

    @@ -107,7 +115,7 @@

    Examples of Findable Help

    From e3bc8e700d32364cc08641304cdc5ccdfb0d1675 Mon Sep 17 00:00:00 2001 From: Alastair Campbell Date: Sun, 19 Jul 2020 20:50:48 +0100 Subject: [PATCH 10/11] Prepping for merge --- techniques/general/{FindableHelp.html => G219.html} | 0 understanding/22/findable-help.html | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename techniques/general/{FindableHelp.html => G219.html} (100%) diff --git a/techniques/general/FindableHelp.html b/techniques/general/G219.html similarity index 100% rename from techniques/general/FindableHelp.html rename to techniques/general/G219.html diff --git a/understanding/22/findable-help.html b/understanding/22/findable-help.html index d4719b9977..a54bbecabb 100644 --- a/understanding/22/findable-help.html +++ b/understanding/22/findable-help.html @@ -128,7 +128,7 @@

    Techniques for Findable Help

    Sufficient Techniques for Findable Help

      -
    1. Provide a contact-us link
      2. +
    2. Provide a contact-us link
    From 906e71a618c883b0ed319071ba38a8e9d5d5dd61 Mon Sep 17 00:00:00 2001 From: Alastair Campbell Date: Sun, 19 Jul 2020 20:53:15 +0100 Subject: [PATCH 11/11] Updating technique number --- techniques/general/{G219.html => G220.html} | 0 understanding/22/findable-help.html | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename techniques/general/{G219.html => G220.html} (100%) diff --git a/techniques/general/G219.html b/techniques/general/G220.html similarity index 100% rename from techniques/general/G219.html rename to techniques/general/G220.html diff --git a/understanding/22/findable-help.html b/understanding/22/findable-help.html index a54bbecabb..b1888a60f0 100644 --- a/understanding/22/findable-help.html +++ b/understanding/22/findable-help.html @@ -128,7 +128,7 @@

    Techniques for Findable Help

    Sufficient Techniques for Findable Help

      -
    1. Provide a contact-us link
      2. +
    2. Provide a contact-us link