This talk was presented at API The Docs Virtual 2022 event series on 16 November. We are glad to present the video recording, and talk summary below. Enjoy!
Visit the talk listing page for an overview of all presentations!
Principal Software Engineering Lead at Microsoft
In this talk, Mary Kate shares a linter to curb the use of non-inclusive language when writing documents or code. The linter provides helpful alternatives, and it can be customized. This helps not only with documentation, but how we speak to each other.
Words have a direct and indirect impact on those who hear or read them. The smallest changes in the words you choose might cause huge emotional differences.
You have to:
Inclusive language is designed to avoid excluding people on the basis of gender, sexual preference, age, race, ability, etc. It avoids offensive language, and aims for social justice.
As a professional, you should:
Woke: A flexible, language-agnostic liting tool that multiple teams and organizations can use. Based on different rulesets, the tool can detect non-inclusive words, and recommend alternatives: - you can add custom rulesets and define terms to lint for, - rulesets are highly configurable and applied at runtime, - you can store rulesets locally or on Github, - check your comments and variable names as well.
Use a CLI, Github action, or the available text editor plugin to leverage the tool. You can run it locally or implement it into your CI/CD pipeline.
After the introductory part of the presentation, Mary Kate demoed the linter.