Skip to content

Commit

Permalink
Add first draft explainers for two more specs
Browse files Browse the repository at this point in the history
  • Loading branch information
matatk committed Nov 21, 2023
1 parent 338df0d commit 3bc6a7d
Show file tree
Hide file tree
Showing 2 changed files with 163 additions and 0 deletions.
66 changes: 66 additions & 0 deletions explainers/accessibility-meta.md
@@ -0,0 +1,66 @@
# Accessibility statement schema and metadata

## Authors

- Matthew Tylee Atkinson (@matatk), Samsung Electronics

## Introduction

Accessibility statements provide detailed information from a site developer about:

* Which assistive technologies they support.
* Known issues.

This comment has been minimized.

Copy link
@abhina-kumar

abhina-kumar Nov 21, 2023

Is it going to link to vpat / acr? Or is it going to doubly maintained here?

* Plans for further accessibility improvements.

This comment has been minimized.

Copy link
@abhina-kumar

abhina-kumar Nov 21, 2023

Is it going to be plain English or some format?

* Contact details so that visitors can request help, or report problems.

This spec provides a standard schema for providing this information, with the following goals.

## Motivating Use Cases

* Improved consistency of accessibility statements across sites.
- This will make the statements more useful for humans.
* Make the statements machine readable.

This comment has been minimized.

Copy link
@abhina-kumar

abhina-kumar Nov 21, 2023

Can we elaborate on what is exactly meant by machine readable here?


> **TODO:** Prediction: machine readability may give some organisations concerns (as it makes researching easier).

This comment has been minimized.

Copy link
@abhina-kumar

abhina-kumar Nov 21, 2023

Isn't it public today also with acr / v-pat?

## Non-goals

* Specifying the _location_ (URI) of the accessibility statement. This is the subject of a separate specification.
* Providing the means for accessibility reporting, in the following ways. Both of these are covered by a separate specification.
- Providing the means for accessibility test results to be automatically, semi-automatically, or manually reported.
- Providing the means for people to report difficulties they are having on a given page.

> **TODO:** Link to the other specs/explainers.
## User research

> **TODO**
## Schema for accessibility statements

> **TODO**
This section will detail:

* What types of information can go into an accessibility statement.
* How each is to be identified and encoded.

## Key scenarios

> **TODO**
## Detailed design discussion

> **TODO**
## Considered alternatives

> **TODO**
## Stakeholder Feedback / Opposition

> **TODO**
## References & acknowledgements

> **TODO**
97 changes: 97 additions & 0 deletions explainers/accessibility-reporting.md
@@ -0,0 +1,97 @@
# Accessibility reporting: use cases, endpoints, and schema

## Authors

- Matthew Tylee Atkinson (@matatk), Samsung Electronics

## Introduction

> **TODO**
This work builds on the [Reporting API](https://www.w3.org/TR/reporting-1/).

## Motivating Use Cases

* Providing the means for accessibility test results to be automatically, semi-automatically, or manually reported.
* Providing the means for people to report difficulties they are having on a given page.

> **Note:** It is anticipated that using infrastructure such as the Reporting API will be particularly helpful in situations where pages are comprised of content obtained from multiple sources, because the reporting can be done "at the edge" where this content is combined.
>
> To be useful, though, this will require organisations to be able to reproduce (or at least approximate) the assembled content, based on the information provided by the report.
## Non-goals

* Specifying the location (URI) of the accessibility statement. This is the subject of a separate specification.
* Specifying the schema of the machine-readable accessibility statement. This is the subject of a separate specification.

> **TODO:** Link to the other specs/explainers.
## User research

> **TODO**
## Accessibility reporting mechanisms

### Reporting endpoint for accessibility results

> **TODO**
We will standardise an endpiont to be used for accessibility reporting—or possibly two endpoints:

This comment has been minimized.

Copy link
@abhina-kumar

abhina-kumar Nov 21, 2023

Why can't it be part of contents which are mentioned in the accessibility-meta?

Eg. RFC 9116 details many fields to capture various information. Can't similar approach be taken?


* A reporting endpoint for (automatic, semi-automatic) inspection tooling.
* A reporting endpoint for issues that a user reports (manually, or with assistance from a tool that may include attachments, like screengrabs) when they encounter an error.

### Schema for automated accessibility reports

> **TODO**
We will standardise a schema to be used by automated accessibilty tooling.

This comment has been minimized.

Copy link
@abhina-kumar

abhina-kumar Nov 21, 2023

Why we need to standardize it as part of well-known? Is it not standardized in Reporting API?


Challenges include:

* Scoping (Just WCAG, or also best practices—in which case, how should they be flagged?)
* Identifying the part of the page that is affected.
* Attachments.
* Units.

We will probably find help with this via the [Accessibility Conformance Testing (ACT)](https://www.w3.org/WAI/standards-guidelines/act/).

### Schema for accessibility barriers affecting users

> **TODO**
We will standardise a schema for providing reports from users.

## Key scenarios

### An automated accessibility scanner

> **TODO**
### Manual in-browser accessibility inspection tools

> **TODO**
### A site visitor experiencing barriers

> **TODO**
## Detailed design discussion

> **TODO**
## Considered alternatives

> **TODO**
## Stakeholder Feedback / Opposition

> **TODO**
## References & acknowledgements

> **TODO**
* [Research Questions TF: Use cases for the Reporting API](https://www.w3.org/WAI/APA/task-forces/research-questions/wiki/Reporting_API_Use_Cases)
* [Accessibility Conformance Testing (ACT)](https://www.w3.org/WAI/standards-guidelines/act/)
* [Reporting API](https://www.w3.org/TR/reporting-1/)

1 comment on commit 3bc6a7d

@abhina-kumar
Copy link

Choose a reason for hiding this comment

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

@matatk:

  1. I think there was a discussion in the meeting that meta information cannot be part of spec. But if you see RFC 9116 - https://datatracker.ietf.org/doc/html/rfc9116#section-2.5, it specifies the field definitions.

  2. Can you provide the link to the spec you are writing, so that me and Vikas can also contribute there :-)

Cheers,
Abhinav

Please sign in to comment.