RE: ATAG2 Action item re: documenting features

Thanks - good work

Minor Questions: Do the categories taken together cover all possible features of the authoring tool?   Do they overlap at all! I assume for c that the feature (service) is explained (documented) elsewhere?   Also what constitutes a sufficient explanation for testing purposes?

Tim Boland

From: Richards, Jan [mailto:jrichards@ocadu.ca]
Sent: Wednesday, January 11, 2012 11:17 PM
To: w3c-wai-au@w3.org
Subject: ATAG2 Action item re: documenting features

On Monday's call I took this action:
"JR to To propose something for A.4.2.1 that includes user interactive features and a note on platform conventions being documented elsewhere"

Here's my proposal (affecting both A.4.2.1 and A.4.2.2). I've tried to move to "explain" from "document" to avoid appearing to require a formal help system:
A.4.2.1 Explain Accessibility Features:  For each authoring tool feature that is used to meet Part A of ATAG 2.0, at least one of the following is true:
(a) Explained in documentation: use of the feature is explained in the authoring tool's documentation; or
(b) Explained in interface: use of the feature is explained in the user interface; or
(c) Platform service: the feature is a service provided by an underlying platform; or
(d) Not used by authors: the feature is not used directly by authors (e.g., passing information to a platform accessibility service)
Note: The accessibility of the documentation is covered by Guideline A.1.1 and Guideline A.1.2.

A.4.2.1 Explain All Features:  For each authoring tool feature, at least one of the following is true:
(a) Explained in documentation: use of the feature is explained in the authoring tool's documentation; or
(b) Explained in interface: use of the feature is explained in the user interface; or
(c) Platform service: the feature is a service provided by an underlying platform; or
(d) Not used by authors: the feature is not used directly by authors (e.g., passing information to a platform accessibility service)
Note: The accessibility of the documentation is covered by Guideline A.1.1 and Guideline A.1.2.


EXISTING TEXT:
A.4.2.1 Document Accessibility Features:  All features of the authoring tool @@that are used to must be present to meet Part A of ATAG 2.0 (e.g., keyboard shortcuts, text search) are documented. (Level A)
Note: The accessibility of the documentation is covered by Guideline A.1.1 and Guideline A.1.2.

A.4.2.2 Document All Features: The authoring tool includes documentation for its author-level user interface features. (Level AA)
Note: The accessibility of the documentation is covered by Guideline A.1.1 and Guideline A.1.2.

Cheers,
Jan

(MR) JAN RICHARDS
PROJECT MANAGER
INCLUSIVE DESIGN RESEARCH CENTRE (IDRC)

T 416 977 6000 x3957
F 416 977 9844
E jrichards@ocadu.ca<mailto:jrichards@ocadu.ca>

Twitter @OCAD<http://twitter.com/ocad>
Facebook www.facebook.com/OCADUniversity<http://www.facebook.com/ocaduniversity>

OCAD UNIVERSITY
205 Richmond Street West, 2nd Floor, Toronto, Canada  M5V 1V3
www.ocadu.ca
idrc.ocadu.ca<http://idrc.ocadu.ca/>