Skip to content

Assertions are too long and hard to follow. Please replace the text of how to write an assertion, with a link. #655

Description

@lseeman

#Assertions are too long and hard to follow. Please replace the text of how to write an assertion, with a link.

Issue description:

Assertions look very difficult because of all the template information. The template is very wordy and repetitive and makes it hard to find or focus on the few details that are unique to a specific assertion. That The templated information can be in a different section (maybe in conformance) and linked to.

For example the following could replace the text below:

Create an assertion as defined in the conformance section to show the following:

1.Our organization has:

  • a style guide that includes guidance on focus indicators, and
  • a policy and/or processes that the style guide must be followed.

This would replace the following text (taken from https://w3c.github.io/wcag3/guidelines/#focus-indicator-style-guide) :

For each form in the conformance claim, we have reviewed the form designs to reduce the possibility of users making mistakes.
This review includes checking to make sure that we:

1.Our organization has a style guide that includes guidance on focus indicators and a policy and/or processes that the style guide must be followed.

Information that needs to be included publicly:

Title, role or organization making the assertion
Date of assertion (if different from the date of the conformance claim)
Recommended internal documentation (Informative):

Documentation of which forms were reviewed
Documentation of any changes made as a result of the review
Date of usability testing, if applicable

By the way, we also broke out the actionable text into bullet points. We feel that that is also easier to read.

Thanks!
The coga task force

Metadata

Metadata

Assignees

No one assigned

    Labels

    ConformanceIssues relating to the conformance modelcogaOf interest to the coga taskforce

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions