Start Free Trial Book a Demo

How to write inclusive documentation?

Speaker

Jessica Valero-Gil

Senior Technical Writer

Duration

1 Hour

Presentation

Download Deck

Google defines inclusiveness as “the practice or policy of including people who might otherwise be excluded or marginalized”. It’s a part of accessibility. Language is inclusive when it doesn’t exclude anyone based on characteristics such as gender, physical or mental disability, or cultural background. Showing empathy in your documentation style unlocks the potential of being fair and equal to all. Being inclusive should be a guiding principle for the documentation framework and content writers need to practice in producing bias-free inclusive content.

Key takeaways

  • Best practices in producing inclusive documentation.
  • Role of the right visual elements and using web accessibility guidelines.
  • Do not use albelist language, biased language, and gendered language.
  • Avoid using idioms, slangs, and cultural references while producing documentation.
  • Using tools for checking Web Content Accessibility Guidelines (WCAG) 2.1 guidelines.
  • Tips for writing content for screen readers.
  • Measuring outcomes of inclusive documentation.