From af0bfa0987e9e74ea41f3eb3a6d5b4972420b0b9 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Sat, 11 Feb 2023 10:09:00 +0530 Subject: [PATCH 01/22] Added Inclusive Language Style Docs --- .../styleguide/inclusive-language.md | 57 +++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 pages/docs/community/styleguide/inclusive-language.md diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md new file mode 100644 index 000000000000..858fe3579fcb --- /dev/null +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -0,0 +1,57 @@ +# Style Docs - Inclusive Language: + +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 - + +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. +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. + +### 2. Gender Neutral Language - + +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 - + +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”. +- Using “People with Audio Impairment” instead of “Deaf People”. + +### 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. Often we don’t realize that slang words are included within phrases which have +don’t have collaborative slang meanings. +Some examples include - +- Using “archaic” or “stupid” instead of “moron”. +- Avoid using words like “bloody hell” and “damn”. + +### 5. Ageism Free Language - + +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. +Some examples include - +- Using “lively” instead of “young”. +- Not to mention the exact age like “60 years” old. + +### 6. Knowledge Assumption Free Language - + +While building the documentation, we should always assure that we don’t presume the knowledge of the readers. +This is because if we assume that our readers are highly skilled in front-end development, +we might 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. From 214b9011e05f4e09b0620a71dee63d6b50ce3e08 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Tue, 21 Feb 2023 21:32:59 +0530 Subject: [PATCH 02/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Karuna Tata <74637789+starlightknown@users.noreply.github.com> --- pages/docs/community/styleguide/inclusive-language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 858fe3579fcb..1bc681c4aec5 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -1,4 +1,4 @@ -# Style Docs - Inclusive Language: +# Inclusive Language 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. From c212e3f97b7105de2833f46137fcc8b613c29afe Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Tue, 21 Feb 2023 21:33:07 +0530 Subject: [PATCH 03/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Karuna Tata <74637789+starlightknown@users.noreply.github.com> --- pages/docs/community/styleguide/inclusive-language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 1bc681c4aec5..e0f4a5547021 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -3,7 +3,7 @@ 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 - +### 1. Culturally Inclusive Language 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. From d67d80df657f81ddca11f022db8f016894462aba Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Wed, 8 Mar 2023 10:50:29 +0530 Subject: [PATCH 04/22] Metadata added --- pages/docs/community/styleguide/inclusive-language.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index e0f4a5547021..3845ec47d7a3 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -1,3 +1,9 @@ +--- +title: Inclusive Language style guide +description: This style guide outlines the guideline for using inclusive languages in documentation. +weight: +--- + # Inclusive Language While writing documentation we are indirectly reaching out to thousands of people all around the globe. From ef4ddcfaf4c36eca9c9a55ee9a15c81bcdd47d66 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Wed, 8 Mar 2023 10:51:04 +0530 Subject: [PATCH 05/22] Update inclusive-language.md --- pages/docs/community/styleguide/inclusive-language.md | 1 - 1 file changed, 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 3845ec47d7a3..67bd8c545277 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -1,7 +1,6 @@ --- title: Inclusive Language style guide description: This style guide outlines the guideline for using inclusive languages in documentation. -weight: --- # Inclusive Language From 5ebf702008aa9b5ec13a29acccb63b4082c96b28 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 10 Mar 2023 10:07:39 +0530 Subject: [PATCH 06/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 67bd8c545277..244f7aa7e1c3 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -31,7 +31,7 @@ Some examples of Gender Neutral Language are - 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”. +- Using “People with a mental health condition” instead of “Mentally Unstable People”. - Using “People with Audio Impairment” instead of “Deaf People”. ### 4. Slang Free Language - From db1f99bb1beb2b247840fc89e699c5f59e56d76c Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 10 Mar 2023 10:08:10 +0530 Subject: [PATCH 07/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 244f7aa7e1c3..040b29d49cb0 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -32,7 +32,7 @@ The placement of the word “People” matters a lot when it comes to writing do 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 a mental health condition” instead of “Mentally Unstable People”. -- Using “People with Audio Impairment” instead of “Deaf People”. +- Using “Deaf” instead of “Person with deafness”. ### 4. Slang Free Language - From 22e736520e1e532562342fb77ad02c5629ddab15 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 10 Mar 2023 10:10:54 +0530 Subject: [PATCH 08/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 040b29d49cb0..08a7b49313dc 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -54,7 +54,7 @@ Some examples include - ### 6. Knowledge Assumption Free Language - While building the documentation, we should always assure that we don’t presume the knowledge of the readers. -This is because if we assume that our readers are highly skilled in front-end development, +This is because if we assume that our readers are highly skilled or have advanced experience, we might 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 - From 4e08e6a23d32066175f7000b0c9f3c6633ad5537 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 10 Mar 2023 10:11:15 +0530 Subject: [PATCH 09/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 08a7b49313dc..1506fefa82c1 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -51,7 +51,7 @@ Some examples include - - Using “lively” instead of “young”. - Not to mention the exact age like “60 years” old. -### 6. Knowledge Assumption Free Language - +### 6. Knowledge level assumption free language While building the documentation, we should always assure that we don’t presume the knowledge of the readers. This is because if we assume that our readers are highly skilled or have advanced experience, From 6d86cf9e715735e067840bd0322434299922a580 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 10 Mar 2023 10:13:18 +0530 Subject: [PATCH 10/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 1506fefa82c1..af9e81493fd5 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -53,7 +53,7 @@ Some examples include - ### 6. Knowledge level assumption free language -While building the documentation, we should always assure that we don’t presume the knowledge of the readers. +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 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. From 08274989a0f4fec87a008cc561dd70dfe2c0eb49 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 10 Mar 2023 12:19:21 +0530 Subject: [PATCH 11/22] Added improvement suggestions --- .../styleguide/inclusive-language.md | 36 ++++++++++++------- 1 file changed, 24 insertions(+), 12 deletions(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index af9e81493fd5..f3a0a5d3af58 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -1,6 +1,6 @@ --- -title: Inclusive Language style guide -description: This style guide outlines the guideline for using inclusive languages in documentation. +Title: Inclusive Language style guide +Description: This style guide outlines the guideline for using inclusive languages in documentation. --- # Inclusive Language @@ -8,7 +8,7 @@ description: This style guide outlines the guideline for using inclusive languag 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 +## 1. Culturally inclusive language 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. @@ -17,41 +17,53 @@ Some examples of Region Specific Language are - - 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. -### 2. Gender Neutral Language - +## 2. Gender neutral language 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. +left out while reading our documentation. Using only male pronouns, can make women in technology feel left out. +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". -### 3. People First Language - +## 3. People first language 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 a mental health condition” instead of “Mentally Unstable People”. - Using “Deaf” instead of “Person with deafness”. +- Using "People with a disability" instead of "Disabled eople". +- Using "Wheelchair Users" instead of "Wheelchair bound". +- Using "People experiencing homelessness" instead of "Homeless people" -### 4. Slang Free Language - +## 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. Often we don’t realize that slang words are included within phrases which have don’t have collaborative slang meanings. Some examples include - -- Using “archaic” or “stupid” instead of “moron”. -- Avoid using words like “bloody hell” and “damn”. +- 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 - +## 5. Ageism free language 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. 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”. -- Not to mention the exact age like “60 years” old. +- 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 +## 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, From 8f5a96bda9fa36697df096e68a006528a80d4490 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Tue, 14 Mar 2023 10:04:31 +0530 Subject: [PATCH 12/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> --- pages/docs/community/styleguide/inclusive-language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index f3a0a5d3af58..7e8fccb2734c 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -1,5 +1,5 @@ --- -Title: Inclusive Language style guide +title: Inclusive Language style guide Description: This style guide outlines the guideline for using inclusive languages in documentation. --- From ff8ec4e8ebffc3d032c27a559036dacb3bac9c9f Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Wed, 15 Mar 2023 21:45:57 +0530 Subject: [PATCH 13/22] Update inclusive-language.md --- pages/docs/community/styleguide/inclusive-language.md | 1 + 1 file changed, 1 insertion(+) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 7e8fccb2734c..9d8bb24cfa68 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -28,6 +28,7 @@ Some examples of Gender Neutral Language are - - 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". +- Avoid using sterotypes such as linking "male" with "strength", "women" with "care work", "male homosexuality" with "sensitivity". ## 3. People first language From 505b81ee1d86b74af37c7a822feb54945454fec7 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Sun, 2 Apr 2023 10:38:35 +0530 Subject: [PATCH 14/22] Added changes and updations --- pages/docs/community/styleguide/inclusive-language.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 9d8bb24cfa68..038fe32d8729 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -16,6 +16,8 @@ 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. +- 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 @@ -28,18 +30,23 @@ Some examples of Gender Neutral Language are - - 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. People first language +## 3. Accessibility and Disability 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. 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 eople". - 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", "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 @@ -73,3 +80,5 @@ 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." From b6133ef92f7eaac704359813d4a208aad1abc255 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 16 Jun 2023 11:35:40 +0530 Subject: [PATCH 15/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 038fe32d8729..6a34ed110c66 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -42,7 +42,7 @@ the assumption that people with disabilities are inferior to those without disab 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 eople". +- 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", "lame". From 9efd50cc2ad6f9cab4890123eb43542bb00068ea Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 16 Jun 2023 11:35:51 +0530 Subject: [PATCH 16/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 6a34ed110c66..6dac1883224a 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -15,7 +15,7 @@ of the world might need help to relate to the same. Hence, we should try to avoi 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. +- “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. From 899b69f85f7db41c0da387762c905a6621036590 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 16 Jun 2023 11:36:13 +0530 Subject: [PATCH 17/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 6dac1883224a..060fa503c3a2 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -10,8 +10,7 @@ Thus, we must ensure that our diverse audience can connect with our information. ## 1. Culturally inclusive language -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. +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. From 303508653a3ae5e02a7f06dedd335152fdb20e7b Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 16 Jun 2023 11:36:22 +0530 Subject: [PATCH 18/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 060fa503c3a2..750e384f638f 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -50,8 +50,7 @@ Some examples of Gender Neutral Language are - ## 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. Often we don’t realize that slang words are included within phrases which have -don’t have collaborative slang meanings. +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". From 32b1217f3d33850f50898bdaaafff6994fd96006 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 16 Jun 2023 11:36:29 +0530 Subject: [PATCH 19/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 750e384f638f..0748217353c4 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -60,8 +60,7 @@ Some examples include - ## 5. Ageism free language -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. +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" From 98911057564689222cb8455d254a9f00dc82e311 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 16 Jun 2023 11:36:38 +0530 Subject: [PATCH 20/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 0748217353c4..4af644c78e8a 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -72,7 +72,7 @@ Some examples include - 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 skip explaining or linking some important concepts. Also, we should avoid labeling some steps as “easy”, +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”. From c53771d594e93a7d65b98d40b8f47ce669cc9194 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 16 Jun 2023 11:36:46 +0530 Subject: [PATCH 21/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index 4af644c78e8a..ea19cfe82cdc 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -44,7 +44,7 @@ Some examples of Gender Neutral Language are - - 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", "lame". +- 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 From 4ba58b4487a66e6e2812a3eac385ea0b2a338b20 Mon Sep 17 00:00:00 2001 From: Bhaswati Roy Date: Fri, 16 Jun 2023 11:37:16 +0530 Subject: [PATCH 22/22] Update pages/docs/community/styleguide/inclusive-language.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/inclusive-language.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pages/docs/community/styleguide/inclusive-language.md b/pages/docs/community/styleguide/inclusive-language.md index ea19cfe82cdc..4e709d494006 100644 --- a/pages/docs/community/styleguide/inclusive-language.md +++ b/pages/docs/community/styleguide/inclusive-language.md @@ -20,8 +20,7 @@ Some examples of Region Specific Language are - ## 2. Gender neutral language -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. Using only male pronouns, can make women in technology feel left out. +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”.