Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: new style guide - Inclusive Language #1327

Closed
wants to merge 34 commits into from
Closed
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
af0bfa0
Added Inclusive Language Style Docs
BhaswatiRoy Feb 11, 2023
edc05fd
Merge branch 'asyncapi:master' into style-docs
BhaswatiRoy Feb 11, 2023
214b901
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Feb 21, 2023
c212e3f
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Feb 21, 2023
368eede
Merge branch 'master' into style-docs
quetzalliwrites Mar 3, 2023
4edec57
Merge branch 'master' into style-docs
quetzalliwrites Mar 7, 2023
6d37fc4
Merge branch 'master' into style-docs
quetzalliwrites Mar 8, 2023
edefd74
Merge branch 'master' into style-docs
quetzalliwrites Mar 8, 2023
d67d80d
Metadata added
BhaswatiRoy Mar 8, 2023
ef4ddcf
Update inclusive-language.md
BhaswatiRoy Mar 8, 2023
e177a36
Merge branch 'master' into style-docs
quetzalliwrites Mar 9, 2023
7a7bf66
Merge branch 'master' into style-docs
quetzalliwrites Mar 10, 2023
5ebf702
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Mar 10, 2023
db1f99b
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Mar 10, 2023
22e7365
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Mar 10, 2023
4e08e6a
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Mar 10, 2023
6d86cf9
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Mar 10, 2023
0827498
Added improvement suggestions
BhaswatiRoy Mar 10, 2023
4b9b833
Merge branch 'master' into style-docs
quetzalliwrites Mar 10, 2023
5e8fe7a
Merge branch 'master' into style-docs
quetzalliwrites Mar 14, 2023
8f5a96b
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Mar 14, 2023
ff8ec4e
Update inclusive-language.md
BhaswatiRoy Mar 15, 2023
505b81e
Added changes and updations
BhaswatiRoy Apr 2, 2023
b5b380c
Merge branch 'master' into style-docs
quetzalliwrites Apr 4, 2023
158f3c8
Merge branch 'master' into style-docs
quetzalliwrites Jun 13, 2023
919f272
Merge branch 'master' into style-docs
quetzalliwrites Jun 16, 2023
b6133ef
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Jun 16, 2023
9efd50c
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Jun 16, 2023
899b69f
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Jun 16, 2023
3035086
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Jun 16, 2023
32b1217
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Jun 16, 2023
9891105
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Jun 16, 2023
c53771d
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Jun 16, 2023
4ba58b4
Update pages/docs/community/styleguide/inclusive-language.md
BhaswatiRoy Jun 16, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions pages/docs/community/styleguide/inclusive-language.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
title: Inclusive Language style guide
Description: This style guide outlines the guideline for using inclusive languages in documentation.
---

# Inclusive Language
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved

While writing documentation we are indirectly reaching out to thousands of people all around the globe.
Thus, we must ensure that our diverse audience can connect with our information.

## 1. Culturally inclusive language
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved

Certain phrases and words are commonly used in specific regions of the world. Avoid avoiding region-specific language in the documentation.
Some examples of Region Specific Language are -
- “It’s not rocket science” is commonly used in the USA, and non-US people might not be able to relate to it properly.
- Phrases written in regional languages instead of English.
- “It’s a piece of cake” is commonly used in the USA, and non-US people might not be able to relate to it properly.
- Terms like "gypsy" is considered derogatory in Romani community, "eskimo" is considered offensive in artic community.
- Terms like "tipping point" is considered offensive in African American cultures.

## 2. Gender neutral language
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved

BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
Some phrases and words target men or men/women specifically, resulting in other gender groups feeling left out while reading our documentation. Using only male pronouns also make women in technology feel excluded or overlooked.
Similarly, we should also try to include non binary group of people with our writing.
Some examples of Gender Neutral Language are -
- Using “they/them” instead of “his/him” or “she/her”.
- Using “Hello everyone” instead of “Hello guys”.
- Using “Chairperson” instead of “Chairman” or “Chairwoman”.
- Using "people", "guests" or "folks" instead of "ladies and gentlemen".
- Using "Mx" or "Ms" instead of using "Mr" or "Mrs".
- Using "humankind" instead of "mankind".
- Avoid using sterotypes such as linking "male" with "strength", "women" with "care work", "male homosexuality" with "sensitivity".

## 3. Accessibility and Disability

BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
The placement of the word “People” matters a lot when it comes to writing documentation.
Using the word “People” in the beginning makes it more pleasant as the problem is not displayed in the beginning.
The phrasing of sentences should not be in a manner that depicts Ableism or discrimination against individuals with disabilities or
the assumption that people with disabilities are inferior to those without disabilitie.
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
Some examples of Gender Neutral Language are -
- Using “People with a mental health condition” instead of “Mentally Unstable People”.
- Using “Deaf” instead of “Person with deafness”.
- Using "People with a disability" instead of "Disabled people".
- Using "Wheelchair Users" instead of "Wheelchair bound".
- Using "People experiencing homelessness" instead of "Homeless people"
- Avoid using derogatory terms that refer to people with disabilities like "crazy", "retarded", and "lame".
- Try using phrases like "overlook" or "ignore" instead of "turn a blind eye", or using "unheard" or "unnoticed" instead of saying "falling on deaf ears".

## 4. Slang free language

While framing the documentation, we must ensure that we are not including any vulgar language even if those are
included indirectly in our work. We should be mindful of inadvertently including slang words within phrases that may have unintended or inappropriate connotations.
Some examples include -
- Using “simple” or “easy" instead of “no-brainer”.
- Using "simple" or "straightforward" instead of "easy-peasy".
- Avoid using any racist, sexist, or any discriminatory language like "stupid" or "retarted".
- Using "easy" or "simple" instead of "piece of cake".
- Using "excellent" or "impressive" instead of "dope"

## 5. Ageism free language

When constructing the documentation, avoiding words or phrases that may disproportionately emphasize a specific age group is important, making other age groups feel excluded.
Some examples include -
- Avoid mentioning the exact age like “60 years” old.
- Using "experienced" instead of "old-timer"
- Avoid phrases like "you are too old to understand" or "you are too yound to understand"
- Using “lively” instead of “young”.
- Avoid making assumptions about a person's abilities or interests based on their age, like assuming an older adult will not be tech savvy.

## 6. Knowledge level assumption free language

While building the documentation, we should always assure that we don’t presume the knowledge level of the readers.
This is because if we assume that our readers are highly skilled or have advanced experience,
we might inadvertently skip explaining or linking some important concepts. Also, we should avoid labeling some steps as “easy”,
because this might make some readers question their technical abilities.
Some examples include -
- Using “fixing the navbar is good to start with” instead of “fixing the navbar is very easy”.
- Linking complex topics which most of our audience won’t be able to understand.
- Avoid using phrases like "As you already know, the Fourier series is a mathematical method used to represent periodic functions."
- Avoid including phrases like "You're probably familiar with the concept of compound interest, so I won't go into too much detail about it."