Supporting Documents Redesign Project

In this project, we are redesigning what WCAG supporting documents look like, with the goals of making them easier to discover, navigate and apply to web projects (full requirements analysis).

Prototypes and templates

Work in progress templates

Page “All WCAG 2.1 guidance”

The supporting documents are “stand-alone” from the WAI website: they don't contain the full WAI header and navigation. To bridge between these documents and the WAI website and provide context, we will link to the WCAG documents page on the WAI website.

This is where users of one document (e.g. a specific Technique) can find out which other documents exists (Techniques, Understanding, COGA Guidance, etc).

Techniques

Generated

Some of these files are generated with XSLT using ANT from the WCAG repository.

Prototypes

Understanding documents

Generated

Some of these files are generated with XSLT using ANT from the WCAG repository.

Prototypes

ACT Rules

All of these files are generated from Markdown files in wcag-act-rules, a WAI Website style repository, in the use-supporting-docs-template branch, using the stand-alone document layout. PR 51 moves the files to this layout.

COGA Design Patterns

All of these files are generated from Markdown files in wai-coga-design-guide, a WAI Website style repository, using the stand-alone document layout.

Features

A short explanation of how we try address specific user needs (see also user flows, about current user flows and potential issues)

User: I want to find out which other documents exist
All documents link to all guidance page
User: I want to find out which set this document is part of
Blue header at the top has name of the set of documents, for instance “WCAG 2.1 Techniques”.
User: I want to know what kind of document I am looking at
Sidebar contains short sentence that explains the kind of document, for instance “Techniques are examples of ways to meet a WCAG success criterion.”, and there is a link to “About Techniques” in the top navigation.
User: I want to know if the document is “required” (normative or informative)
This should be clear from the sidebar sentence, can be further explained in the “About” page linked from the header.
User: I want to know if guidance is accurate / recent
@@TODO@@ Banner to be displayed if guidance is outdated

Open questions

Changelog