Awesome Inclusivity

The intent of this list is to provide guidelines for writing great, clear, concise, and inclusive documentation. This idea came from a discussion in the hangops #allies channel as I sought feedback on removing the term "master" from policy documentation. The number resources provided made it clear that creating a list for this topic would benefit the community.

If you would like to learn more about general diversity topics please check the Awesome Diversity list, which contains a great list of curated articles, websites, and resources about diversity in technology.

This will always be a work in progress so feedback, suggestions, and pull requests are welcome.

Organizations

• Inclusive Naming Project
  • Word Replacement List
  • A framework for evaluating harmful language
• Inclusive Design Principles by Léonie Watson Henny Swan, Ian Pouncey, and Heydon Pickering

Articles about Inclusive Documentation

• Automating Inclusive Documentation by Paul Grenier
• The Colors of Cybersecurity by Bob Turner
• How to Write Inclusive Documentation by Uwana Ikaiddi

Automation

• alex helps you find gender favoring, polarizing, race related, religion inconsiderate, or other unequal phrasing in text.
  • alex also has a vscode extension.
• prosebot listens for changes to Markdown files (.md) or text files (.txt) in pull requests and runs various checks against them to provide feedback on the English.

Style Guides

• Microsoft's Writing Style Guide
  • Writing for All Abilities
  • Bias-Free Communication
  • Accessibility Terms
• Google's Developer Documentation Style Guide
  • Writing Inclusive Documentation
• Redhat's Official Style Guide
  • Use of Gender References
• Empress Education's Style Guide
  • Writing Inclusive Documentation
  • Writing For a Global Audience

Use of Master/Slave and Other Terms

• Github's Renaming Repository
• Microsoft's Guideline on Master/Slave
• MongoDB's Statement on Removing Racist Language
• Intuit's Statement on 6 Ways to Abolish Racist Language