Skip to content

Commit

Permalink
Create accessibility.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thulieblack authored Jan 29, 2024
1 parent b229755 commit 2550c87
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/styleguide/accessibility.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Accessibility
description: This style guide explains how to include accessibility in the documentation.
weight: 20
---

# Accessibility

At AsyncAPI, we strive to make our documentation/content inclusive, accessible, and unbiased to everyone. We encourage all contributors to have diversity and inclusivity in mind when writing. To ensure this, we have provided an overview of general guidelines to follow.

## Language
- Be clear and concise when writing. Avoid the use of complex language, technical jargon, and verbose explanations.
- Keep paragraphs and sentences short, simple, and to the point.
- Always maintain a uniform structure. Use descriptive headings and subheadings to make navigation easy.
- Use inclusive language and always keep the reader in mind when writing.


## Text
- Use the appropriate heading hierarchy. H1 is used for the main heading while H2 to H6 are used for subsection headings.
- Properly align text for easy readability.
- Avoid using camel case or any unnecessary fonts and formatting.
- Define acronyms or abbreviations and always spell out any signs or symbols.
- Structure your text in a uniform format.

## Links
- Use descriptive and meaningful link text. For example, do not use phrases like *click here* or *follow this link* instead use *see*.
- Always use an external link icon if a link opens up in a new tab.
- Make sure your links or URLs are valid and redirect to the correct destination.

## Multimedia
- Alt text must be clear and descriptive. Not more than 50 characters.
- Always use text rather than images, unless necessary.
- Use SVG instead of PNG or JPEG. It retains quality.
- Provide transcripts and captions for video content.
- Make sure your captions can be translated into various languages.
- Avoid auto-playing media, always provide controls.

## UI
- Use the correct terminologies for UI elements.
- Format tables correctly and keep the text within the grid.
- Use basic HTML for button elements.
- Add icons to describe a function. Use the aria-label attribute when unsure of the icon name.

0 comments on commit 2550c87

Please sign in to comment.