Important note: This Wiki page is edited by participants of the EOWG. It does not necessarily represent consensus and it may have incorrect information or information that is not supported by other Working Group participants, WAI, or W3C. It may also have some very useful information.

Feature requirements for Interactive Guide to Assist Managing Web Accessibility Evaluations

From Education & Outreach
Jump to: navigation, search

Related page: WCAG-EM Report Tool Comments

The Interactive Guide to Assist Managing Web Accessibility Evaluations (Project name: WCAG-Reporter) will guide web accessibility evaluators through the process of evaluating a website using WCAG-EM with WCAG 2.0. WCAG-Reporter will take evaluators through the steps of WCAG-EM, giving them instructions on what to do and feedback about their approach. After completing the process, WCAG-Reporter creates an HTML report of the evaluation, to be shared with the commissioner of the evaluation. Evaluation data can be exported and imported, allowing users to save the data locally and potentially integrate their own tools with WCAG-Reporter.

The requirements described on this page are part of the deliverable for the WAI-Act project. For details, see:

Project resources

Target Audience

This project is mainly focused at web accessibility evaluators. These are people with medium to advanced knowledge of web technologies. They will have at least a basic understanding of Web Accessibility and WCAG 2.0 in particular. The primary focus of the project will be on evaluators with a beginner's understanding of WCAG and WCAG-EM. Reporter will do this by guiding them through the process of evaluating and giving them appropriate instructions when they need it. It should also have easy access relevant documentation.

A secondary group are experienced web accessibility evaluators. These evaluators have greatly varying approaches and procedures which they use to come to their end results. WCAG-Reporter should therefore not enforce one method of evaluating or of reporting, but leave this open to the evaluators. For the beginning evaluators, it is important that these features come with instructions. This enables them to decide what methods of evaluation and reporting work best for their situation.


This means that the tool must:

  1. Provide a step by step guide through WCAG-EM.
  2. Provide direct access to W3C documentation, relevant to the current step in the evaluation
  3. Contain form fields in which users can record:
    1. The scope of the evaluated website
    2. The sample of web pages or web page states
    3. The results of each evaluated success criterion (pass, fail, not present)
    4. Name/Type of report
    5. Version number
    6. Name of the evaluator
    7. Name of the evaluation commissioner
    8. Date for the evaluation (completion date or duration period)
    9. A free form text description of the accessibility problem
  4. Provide the user with an HTML report of the evaluation. This report must:
    1. Contain all the information listed in WCAG-EM Step 5
    2. Be downloadable so that users can host the report on their website.
  5. Be globalized so that the tool can be configured to:
    1. Use different languages, with English as it's default
    2. Use different date formats, with YYYY-MM-DD as the default.
  6. Have separate documentation of the entire system
  7. Conform to WCAG 2.0 level AA
  8. conform to ATAG 2.0

The tool also should:

  1. Be hosted on GitHub as an open source project, so that it can be extended by other developers.
  2. Allow users to enter the optional features for the evaluation report as described in WCAG-EM step 5.
  3. Allow different work flows in the evaluations:
    1. Open sample pages in new tabs, as a batch or individually
    2. Allow marking success criteria as 'completed'
    3. Allow marking sampled pages as 'completed'
    4. Allow hiding of 'completed' pages and criteria
  4. Function mostly on client side technologies, to reduce impact on the server and make installation easier.
  5. At any point during the evaluation be able to export the data to a JSON file.
  6. Open an evaluation using a JSON file containing previously exported data
  7. Help the user keep track of their progress in the evaluation
  8. Allow the user to revise information after it was entered.
  9. Have an About page; indicating how to use the tool and the report

The tool could:

  1. Be extendible, so that plugins can be created that add features to this, such as test for additional requirements or opening sample pages which automatically could start a plugin.
  2. Function on both desktop, tablet and mobile devices.
  3. Allow evaluators to identify when content was not present on a page.
  4. Allow evaluators to link a single accessibility problem to multiple success criteria.
  5. Be easily installed on a server, by:
    1. Allow loading and saving it's data through a RESTful API
    2. Auto-save the content
  6. Track meta data of the report, including who created a certain issue and at which time.
  7. Use the import function to merge multiple evaluation sources into a single evaluation

The tool will not: (For all of these features, plugins could be developed later or by third party developers)

  1. Generate reports when the evaluator did not complete all the required steps or indicate all success criteria (or all sample pages) as completed.
  2. Have a fully formed style, as the app should be integrated in a pre-existing web site from which it will take it's style
  3. Store evaluations on the W3C site or be linked to W3C accounts
  4. Allow customization of the report
  5. Import or export data in XML EARL
  6. Contain assistance for evaluation of individual success criteria or sample pages
  7. Be able to poll a server for new information about the evaluation that might have been provided through other tools.