w3c / wai-aria-intro

2 stars 6 forks source link

[High Level Feedback] too verbose #2

Open nitedog opened 7 years ago

nitedog commented 7 years ago

There is a lot of superfluous text, sections, and entire pages. Some examples for illustration (not a complete list):

sharronrush commented 7 years ago

Suggested rewrite, based on previous feedback: Overview This tutorial demonstrates the following fundamental concepts that developers must understand in order to use ARIA effectively and safely.

  1. Purpose: What ARIA is meant to do
  2. Limits: What ARIA does not do
  3. Risks: Why appropriate use is essential and inappropriate use is dangerous

Objectives • Demonstrate appropriate use of ARIA to build rich experiences that meet accessibility requirements. • How to use the WAI-ARIA Authoring Practices Guide.

Approach The tutorial uses the following approach:

  1. Introduces a scenario where a site redesign replaces accessible HTML radio buttons with a custom radio group, creating an accessibility gap.
  2. Illustrates the gaps and how to address them with ARIA, Javascript and CSS.
  3. Highlight risks by recognizing that authors invoke a contract by using ARIA and the explaining dangers of violating that contract.
shawna-slh commented 7 years ago

Overall language needs to be much more simple, concise, and direct.

/me also edited the first section before seeing above.

This tutorial demonstrates three fundamental concepts that developers need to understand before using ARIA:

  1. Purpose: What ARIA is for.
  2. Limits: What ARIA does not do.
  3. Risks: What can happen with inappropriate ARIA use, and why no ARIA is better than bad ARIA. This tutorial uses an example of replacing HTML radio buttons with custom radio buttons.

+1 to Shadi that Objectives and Plan are not needed. Those seem like internal requirements.

The first page of the each Tutorial lists the subpages -- so the bullet list matches the navigation. I think that is good practice to do on this first pages as well.

hkramer commented 7 years ago

I like Shawn's rewrite. The inclusion of objectives and plan was very confusing. Hard to tell where the content ended and planning document began.

+1 to James suggestion to follow the structure of the other tutorials.

AndrewArch commented 7 years ago

+1 to above comments that Objectives and Plan are not needed on Intro page

nitedog commented 7 years ago

Note that my comments on "Objectives" and "Plan" sections were only examples - I think there are many more things that could be safely cut out throughout the entire resource.

shawna-slh commented 7 years ago

My comment "Overall language needs to be much more simple, concise, and direct." also applied to the entire resource.

sharronrush commented 6 years ago

@mcking65 Matt, please see the issues raised about resource verbosity, above