w3c / wai-wcag-supplemental

Repository to display Design Patterns for People with Cognitive and Learning Disabilities in a WAI website-like template
https://wai-wcag-supplemental.netlify.app/wcag-supplemental/all-supplemental-guidance/
7 stars 16 forks source link

Separate Summary and TOC #18

Closed SteveALee closed 3 years ago

SteveALee commented 3 years ago

The attempt at combining The Coga Summary and TOC was deemed too complex.

SteveALee commented 3 years ago

@nitedog @hidde @shawna-slh

As well as reworking the ToC page I also mocked up how the "At a Glance" page might look like based on the WCAG one.

The thing is they are pretty much the same thing. At least while the ToC is coga only. Or rather the "Coga At A Glace" would have been almost the same as a differently styled "ToC". This is as the WCAG AaG has the related links below it. For coga I replaced this with the Content Usable summary section content to be found as this is what COga TF want. If we add the links back it looks like the old coga ToC which we felt was too busy.

What do you think?

Note, that now if someone follows the AaG "Read More" link to an objective then there is no quick way to navigate to the list of patterns for that objective (they will be soon removed from the sidebar). So should we add all the pattern links below the objective summary text.

It might be better to have a meeting to discuss this.

nitedog commented 3 years ago

Happy to discuss!

I wonder if the the "COGA At a Glance" should be stand-alone on the WAI website (outside this set of Objectives and Patterns), like how the "WCAG At a Glance" is stand-alone on the WAI website? I think the primary audience for both resources may be fairly distinct (people who want to get a general idea/summary of COGA provisions vs designers and developers who want to implement specific patterns/practices).

Have you considered listing the patterns at the bottom of the objectives (in the main body, after the paragraphs describing the objective)? Here is an example Understanding document on a Guideline level that lists the Understanding documents on the Success Criteria below this Guideline - maybe we can use the same approach here?

SteveALee commented 3 years ago

I wonder if the the "COGA At a Glance" should be stand-alone on

That is the intention - there's a note at the top of the page to state that. Should find how to make a coloured note so it stands out as an editorial comment. We will then lose the ability generate the content from code but that's not a problem at all.

I think the primary audience for both resources may be fairly distinct

Agree. Plus the ToC will probably expand to cover low vision etc.

Have you considered listing the patterns at the bottom of the objectives

Yes and that is my favourite option - I meant to mention that.