Ensure that documentation promotes the production of accessible content
Both as part of the Product Accessibility working group and New diffs initiative, we are aiming for GitLab to be compliant with Authoring Tool Accessibility Guidelines (ATAG 2.0 AA).
The guidelines we need to follow for documentation to be covered by this issue:
Guideline B.4.2: Ensure that documentation promotes the production of accessible content
- B.4.2.1 Model Practice (WCAG): A range of examples in the documentation (e.g. markup, screen shots of WYSIWYG editing-views) demonstrate accessible authoring practices (WCAG). (Level A to meet WCAG 2.0 Level A success criteria; Level AA to meet WCAG 2.0 Level A and AA success criteria; Level AAA to meet all WCAG 2.0 success criteria). See Implementation guidelines.
- B.4.2.2 Feature Instructions: Instructions for using any accessible content support features appear in the documentation. (Level A). See implementation guide.
Practical guide
- Include guidance on how to write the content to make it accessible:
- phrasing a link as a question or instruction,
- keeping the hierarchy of headers,
- how and what to write the image's alt text/video or audio description,
- how to create accessible tables.
Some of them will be a short instruction, but I imagine that for more complicated or detailed cases we could reference another resources or even tools (I'm thinking about tables, audio and video descriptions).
Check this article that may serve as an example.
Implementation Guide
These pages should include accessibility guidance:
-
Markdown guide https://docs.gitlab.com/ee/user/markdown.html#markdown-and-accessibility -
Rich text editor https://docs.gitlab.com/ee/user/rich_text_editor.html
Edited by Marcin Sedlak-Jakubowski