search

w3c / wcag-em-report-tool

Interactive Guide to Assist Managing Web Accessibility Evaluations
http://www.w3.org/WAI/eval/report-tool/
Other
77 stars 45 forks source link

[Redesign] Homepage content: reduce and add info on Markdown #447

Closed hidde closed 3 years ago

hidde commented 3 years ago

The homepage content is long and academic. Suggested to change to:

This tool helps you turn your accessibility evaluation findings into a report according to the Web Content Accessibility Guidelines Evaluation Methodology (WCAG-EM)

Tips for using this tool:

  • As you use the tool, the Report page lists the success criteria that you have checked and not checked.
  • You can export your report as HTML (web page) and as JSON (structured data).
  • You can format your evaluation with Markdown, so that you can use lists, links and code examples.

(Tips for using this tool copied from ATAG Report Tool, minus the tip about saving content as it was decided against that for this tool)

image

hidde commented 3 years ago

@nitedog I have created a demo showing an updated overview page.

This reuses some of the work EOWG have done on the ART Overview page, ensuring it is short, has just the content users need, and that the most immediate needs are covered above the expand/collapses.

Main features:

  1. Reduces content of first and second paragraph
  2. Adds “Tips for using this tool above”
  3. Adds info on Markdown as part of tips section
  4. Adds section “About WCAG-EM and conformance reporting” (like ART has “About ATAG and authoring tools”) (do we want this?). This explanation was in the first paragraph before, I think it is helpful to give it its own background, and have an explicit heading that indicates this will provide background info
  5. Adds section “Result choices”, like in ART (do we want this?)

Curious to hear what you think of this!

hidde commented 3 years ago

Removing from 28 May milestone as the issue needs discussion before closing.

hidde commented 3 years ago

Comment from @nitedog: remove Result Choices section.

@nitedog please let me know if there are other things you'd like to change and if you have input on a “About WCAG-EM and conformance reporting” section.

nitedog commented 3 years ago

I'm happy with the general approach of reducing the text at the start, and moving details into expand/collapse sections. I feel too much information was removed in this preview. For example, I think the information about saving is fairly important but seems lost.

I suggest:

  1. Rename "About WCAG-EM and conformance reporting" to "About this tool"
  2. Move much of what is currently in "What this tool does" into "About this tool"
  3. Add back "Tips for using this tool" section (instead of "Result Choices" section)
hidde commented 3 years ago

Rename "About WCAG-EM and conformance reporting" to "About this tool"

I feel that would make it less concrete and less to the point. It is also inconsistent with the ATAG Report Tool

Move much of what is currently in "What this tool does" into "About this tool"

Is there anything in the “What this tool does” section that is not currently in the preview? I feel the content in the preview is much easier to parse.

Add back "Tips for using this tool" section (instead of "Result Choices" section)

Do we need all of those tips? I feel many of them are not needed given the content we display there now, others are very obvious (probably less obvious when the old tool launched many years ago, but much more obvious in 2021).

nitedog commented 3 years ago

Rename "About WCAG-EM and conformance reporting" to "About this tool"

I feel that would make it less concrete and less to the point. It is also inconsistent with the ATAG Report Tool

Difficult to say without content in this section. Will you really be explaining WCAG-EM and conformance reporting in this section?

Move much of what is currently in "What this tool does" into "About this tool"

Is there anything in the “What this tool does” section that is not currently in the preview? I feel the content in the preview is much easier to parse.

The information on saving; the fact this tool is not automated as many often expect; who the expected audience is (not for beginners); and maybe other points too.

Add back "Tips for using this tool" section (instead of "Result Choices" section)

Do we need all of those tips? I feel many of them are not needed given the content we display there now, others are very obvious (probably less obvious when the old tool launched many years ago, but much more obvious in 2021).

Not sure about your assumption, in particular for the last two points in that list. Not stuck on it either. But what is the problem if they are under expand/collapse and collapsed by default?

hidde commented 3 years ago

Discussed with @nitedog just now, Hidde to take first stab at it, we will then take it to EOWG for feedback.

hidde commented 3 years ago

Updated (see preview):

hidde commented 3 years ago

Survey response from LK:

The overview page content seems just right to me.

hidde commented 3 years ago

discussed in EOWG on 25 June; generally people are happy with it, do want to have Start call to action as part of main content, which will be addressed in https://github.com/w3c/wcag-em-report-tool/issues/508