nshimiye / a11y

A11y best practices

A11y best practices

Here you will find resources and examples of how to make your website accessible

Introduction

Fun fact:

The word accessibility is abbreviated to "a11y" with the number eleven in the middle referring to the number of letters that the word contains between the first and last letter. It follows an Information and Communications Technology (ICT)-oriented convention, just like internationalization (i18n) and localization (l10n), which are used mostly in the software community.

Source: techopedia

Goal: a11y aims at helping developers create software that can be used by people with disabilities. This is based on webaim's mission.

Structure

-- docs
  |-- a11y
    |-- README.md
    |-- resource.md
    |-- use-cases
      |-- use-case-1.md
      |-- use-case-2.md
      |-- .
      |-- .
      |-- .

resource.md file

This file contains a list of userful resource that can help you understand the use of different a11y related tags and attributes so that your website complies with WCAG.

Each resource has

• A Link to the specified resource.
• A one sentence description of kind of information/Knowledge is provided by this resource.

use-cases folder

This folder contains a list of use-cases, examples of a11y implementation.

Each use-cases or example should:

• Have a description of the use-case/problem being solved.
  • (ex: Allowing user to jump to the main content when they visit a website)
• A Good implementation and why
  • Jump to main content - GOOD
• A Bad implementation (if possible) and why
  • Jump to main content - BAD