A11Y Documentation

[irmerk]

Accord Project documentation needs to be updated to represent our ongoing effort for inclusive design for accessibility. This involves:

Inclusive design is a methodology which enables and draws on the full range of human diversity.

Accessibility is qualities which make an experience open to all and the professional discipline aimed at achieving that.

Checklist:

• Overall accessibility concepts as defined by WCAG 2.1
• Efforts made for inclusive design in Accord Projects's past
  • Incentives to foster participation
• Primary contributors towards accessibility, including initialization and building momentum
• Base requirements as defined by Accord Project to ensure new features are accessible
  • As technical as possible without risk of being soon out of date
  • Referenced as a guide to new contributors
• How to test accessibility
  • Information about screenreaders for manual code testing

Good resources to share:

• The A11Y Project
• WCAG

This will encompass cicero-ui and template-studio-v2, possibly also markdown-editor

[irmerk]

Hacktoberfest:

This issue can provide for multiple pull requests.

[AninditaBasu]

Hi @irmerk, what sort of work and updates are you looking at for this issue?

[irmerk]

@AninditaBasu unsure exactly, was looking for community input on how this could take shape in our documentation.

[hp-plus5]

I'll throw out some topics to cover. I'd love some feedback on these; I'm not well-integrated into this community, so there are some questions and assumptions here that I don't know the value of (or if they're relevant).

• Overall accessibility concepts as defined by X standards (such as The A11y Project, WCAG, or any global legislation that declares necessary accessibility (whether technically specific or not))
• What efforts have been made in Accord's past (especially within cicero-ui and template-studio-v2) to implement inclusive design, and what incentives (if any) have been added to foster participation
• Primary contributors towards accessibility overall, especially in helping bring the issue to light and begin building active momentum
• What are the base requirements as defined by Accord in order to ensure new features are accessible. As technical as possible without creating content that will be almost immediately out of date; it would be nice if this could be referenced as a guide to newcomers wanting to make pull requests.
• How to test accessibility; information about screenreaders used by Accord to help manually test code when required

[irmerk]

@hp-plus5 yes these are great topics. I would say that we aim to be compliant with WCAG 2.1, considering it seems to be the most widespread.

I'm going to turn your points into a checklist in the opening post for this issue to follow.

[c02kr]

Hey @irmerk , Please assign this to me .

[c02kr]

thanks @irmerk, for assigning me this project. I need some guidance please help me get started.

[irmerk]

Sure @ch-nd-n. I think a good start would be accumulating information that is applicable to AP in regards to accessibility and creating a PR for a section within https://docs.accordproject.org/docs/ref-web-components-overview.html. Using the material in the OP of this Issue would be helpful I think.

[c02kr]

Thanks, I am on it.