[DRAFT] Requirements/Analysis and changelog for WAI-ARIA documents for education & outreach

Page Contents

Purpose, Goals, Objectives
Audience
Approach
Notes
Consider for later version
References
Changelog

(This page updated $Date: 2007/11/23 21:40:15 $ )

Latest Drafts:

Purpose, Goals, Objectives

Provide people the information they need about WAI-ARIA, given the extremely wide audience for the WAI-ARIA documents
Don't overwhelm readers, especially at first
See "Approach" below

Approach

Provide "progressive disclosure" where people can easily get the basic information from the Overview and FAQ, and then link to more detailed and more technical information as they want.
Overview first: Position the Overview as the first document for everyone to read.
- Link to it near the front of all other documents.
- Do not repeat much from it in the other documents.
- Assume that readers of other documents have already read the Overview (although maybe not well and maybe not recently).
FAQ
- Main purpose of the FAQ is to provide quick answers to key questions, concerns, and myths; and provide an approachable way into more details for those who want it.
- FAQ should be quickly skimmable and not very long.
- The FAQ is an optional document. Make sure key information is in other documents.
Primer
- Main purpose of the Primer is to provide the conceptual background and framework.
- (Lisa currently proposing content from the current Roadmap and recent draft Best Practices.)
Best Practices Guide
- Main purpose is providing easy to follow instructions for content developers -- who want quick stuff and not unnecessary background.
- Keep this as minimalist as feasible, and point to other docs for additional material.
- Assume that readers know the information from the Overview only, not from the Primer or other technical documents.
Roadmap
- Being edited to be more of a Requirements document that defines PFWG's work on WAI-ARIA; taking out material of general interest
Presentation Material
- About WAI-ARIA
- Applying WAI-ARIA

Audience and Document Use

Technical specification (e.g., HTML5) developers

Tool developers

Developers of Web browsers, assistive technologies, other user agents
Developers of authoring tools and accessibility evaluation tools

Content developers wanting to make their web pages, applications, and site accessible, particularly those using or considering using Ajax and such

Library users (e.g., DoJo)
From scratch developers
Testers

Presenters, trainers, consultants, advocates; some project managers

Anyone interested in Web accessibility, including hig-level project managers, policy makers, administrators, ...

The table below lists audiences and indicates whether they are a primary audience for a document &/or how much they are expected to use the different documents.

	Overview	FAQ	Primer	Best Practices	Roadmap	Roles, States & Properties
1. Spec developers	Primary	Somewhat	Somewhat	Somewhat	Somewhat	Primary
2. Tool developers	Primary	Somewhat	Primary	Secondary	A few	Primary
3. Content developers	Primary	Primary	Secondary	Primary	A few	Rarely
4. Presenters	Primary	Primary	Many	Many	A few	A few
5. All, non-tech	Primary	Secondary	A few	A few	A few	Rarely

Overview

FAQ

Primer

Best Practices

Roadmap

Roles, States & Properties

1. Spec developers

Primary

Somewhat

Primary

2. Tool developers

Primary

Somewhat

Primary

Secondary

A few

Primary

3. Content developers

Primary

Primary

Secondary

Primary

A few

Rarely

4. Presenters

Primary

Primary

Many

A few

5. All, non-tech

Primary

Secondary

A few

Rarely

Notes

Terminology and usage of "WAI-ARIA"

Generally use "WAI-ARIA" as the abbreviation (instead of only ARIA)

Always use WAI-ARIA in headings and on first use
In a single document where is appears frequently, it can be abbreviated to ARIA in some places; for example, see the first paragraph under "WAI-ARIA Suite" at www.w3.org/WAI/intro/aria#is
It's fine to say just "ARIA" in casual conversation
(This terminology and usage guidance is motivated by avoiding trademark issues.)

WAI-ARIA refers to the entire suite of documents, including the technical documents and the best practices guide. However, feel free to use "WAI-ARIA Suite" where you want to emphasis that there are multiple documents. All of these are acceptable uses:

WAI-ARIA defines how to...
The WAI-ARIA Suite provides...
Updated Working Drafts of the WAI-ARIA documents...

Open Issues:

Overage of topics in the different documents - How to balance not repeating too much information with not making people read lots of different documents?

Best Practices Guide - How to provide progressive disclosure of information? How to provide short, quick guideance to developers who do not want background and extra details? Perhaps have two documents?

FAQ - How much detail to provide here, versus pointing to in other documents?

Changelog

...

Document Information

Content last updated: $Date: 2007/11/23 21:40:15 $
Editor: Shawn Lawton Henry. Developed by participants of the Education and Outreach Working Group (EOWG).

[Contacting WAI] Feedback welcome to wai-eo-editors@w3.org (a publicly archived list).

Copyright © 1994-2007 W3C^® (MIT, ERCIM, Keio), All Rights Reserved. W3C liability, trademark, document use and software licensing rules apply. Your interactions with this site are in accordance with our public and Member privacy statements.

Site Navigation

[DRAFT] Requirements/Analysis and changelog for WAI-ARIA documents for education & outreach

Page Contents

Purpose, Goals, Objectives

Approach

Audience and Document Use

Notes

Terminology and usage of "WAI-ARIA"

Open Issues:

Consider for later version

References

Archive

Changelog

Document Information