Session
Bring Swagger and A11yship to API documentation
Good documentation accelerates development and consumption, and reduces the money and time that would otherwise be spent answering support calls. Documentation is part of the overall user experience, and is one of the biggest factors for increased API growth and usage.
By integrating with color coded user interface that maps out the blueprint for APIs it benefits the following ways :
1. Documentation is comprehensible for both developers and non-developers like clients or project managers.
2. Specifications are human and machine readable.
3. Generates interactive, easily testable documentation.
This coupled with A11y-Friendly words and phrases like
1. Use "people with disabilities" instead of "disabled people" to prioritize personhood over disability.
2. Instead of "able-bodied," use "non-disabled" to refer to individuals who do not have disabilities.
3. Use "accessible" instead of "handicap accessible" to describe spaces, buildings, or facilities that are designed for use by all people.
4. Instead of "visually impaired," use "people with visual impairments" or "people who are blind or have low vision" to describe individuals with visual disabilities.
5.Use "screen reader" instead of "reader software" to refer to assistive technology that reads aloud text on a computer screen.
6.Instead of "normal" or "typical," use "average" or "common" to avoid implying that people with disabilities are abnormal.
7. Use "inclusive" or "inclusive design" instead of "accessible design" to emphasize the goal of designing for all users.
It is pertinent to note that language is constantly evolving, and it's important to listen to feedback and preferences from the disability community. Respectful and inclusive language promotes a more accessible and inclusive web environment for all users.
Vaishnavi Venkata Subramanian
Software Engineer | Career Mentor| Public Speaker | Community Builder | GDG Organizer
Vancouver, Canada
Links
Please note that Sessionize is not responsible for the accuracy or validity of the data provided by speakers. If you suspect this profile to be fake or spam, please let us know.
Jump to top