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 2 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
Jun 13, 2023
919f272
Merge branch 'master' into style-docs
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
57 changes: 57 additions & 0 deletions pages/docs/community/styleguide/inclusive-language.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Style Docs - 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

Some phrases and words are popularly used only in specific regions of the world, thus our audience from other parts
of the world might need help to relate to the same. Hence, we should try to avoid using such phrases in our documentation.
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
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 not a piece of cake” is commonly used in the USA, and non-US people might not be able to relate to it properly.
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved

### 2. Gender Neutral Language -

BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
Some phrases and words are targeting men or men/women specifically. This might result in other gender groups feeling
left out while reading our documentation.
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”.

### 3. People First Language -

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.
Some examples of Gender Neutral Language are -
- Using “People with Mental Instability” instead of “Mentally Unstable People”.
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
- Using “People with Audio Impairment” instead of “Deaf People”.
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved

### 4. Slang Free Language -
Copy link
Member

@quetzalliwrites quetzalliwrites Mar 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is titled slang, but focuses on vulgar language.

Slang and vulgar language are not the same, although they certainly may overlap in some cases. Slang refers to informal words or expressions that are often used in specific communities or groups, and it can be considered more casual or colloquial than standard language. (Slang terms are not inherently vulgar or offensive.)

On the other hand, vulgar language refers to language that is considered crude, obscene, or offensive. It often includes swear words, sexually explicit language, and may be considered inappropriate in certain contexts or situations. Vulgar language can be slang, but not all slang is vulgar.

ACTION ITEMS:

  1. Please fix this section and re-write it to actually focus on slang topic with dedicated slang examples.
  2. Please add an additional section and header for vulgar, which is it's own topic that deserves it's own examples. Please remember to be cautious what examples you add to this section and be mindful to select examples that do not make the community feel triggered or offended.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here are some examples of incorrect slang terms and corrected alternatives to help you get started! ✨

Incorrect Slang Terms:

  • "Crazy" - using this term to describe something unusual or unexpected is stigmatizing and offensive to people with mental health conditions.
  • "Lame" - using this term to describe something boring or uncool is hurtful to people with disabilities.
  • "Gay" - using this term as an insult or to describe something negative or undesirable is homophobic and offensive to the LGBTQ+ community.
  • "Redneck" - using this term to describe someone from a rural area can be pejorative and offensive.
  • "Ghetto" - using this term to describe something low-quality or undesirable can be stigmatizing and offensive to people living in poverty or urban areas.

Corrected Alternatives:

  • "Unusual," "unexpected," or "surprising"
  • "Boring," "uncool," or "uninteresting"
  • Use language that is not insulting or offensive to any particular group. For example, instead of saying, "that's so gay," you could say, "that's not my thing," or "that's not cool."
  • "Rural," "country," or "small town"
  • "Low-quality," "undesirable," or "run-down"

source: This is the edited version of the query reply I received from ChatGPT when I asked it for 5 ideas of incorrect slang terms and corrected alternatives.


While framing the documentation, we must ensure that we are not including any vulgar language even if those are
included indirectly in our work. Often we don’t realize that slang words are included within phrases which have
don’t have collaborative slang meanings.
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
Some examples include -
- Using “archaic” or “stupid” instead of “moron”.
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
- Avoid using words like “bloody hell” and “damn”.
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved

### 5. Ageism Free Language -
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved

While constructing the documentation, we need to make sure to avoid words or phrases that might emphasize more
on a specific age group that can make the other age groups feel left out.
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
Some examples include -
- Using “lively” instead of “young”.
- Not to mention the exact age like “60 years” old.

### 6. Knowledge Assumption Free Language -
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved

While building the documentation, we should always assure that we don’t presume the knowledge of the readers.
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
This is because if we assume that our readers are highly skilled in front-end development,
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
we might skip explaining or linking some important concepts. Also, we should avoid labeling some steps as “easy”,
BhaswatiRoy marked this conversation as resolved.
Show resolved Hide resolved
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.