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.

Sign up for GitHub

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

Jump to bottom

Avoid using gendered pronouns - add links to alexjs #8339

Merged
merged 2 commits into from
Apr 11, 2024
Merged

Avoid using gendered pronouns - add links to alexjs #8339

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3b54f1
Update Rule “avoid-using-gendered-pronouns/rule”
wicksipedia Apr 11, 2024
28c07f6
Update rules/avoid-using-gendered-pronouns/rule.md
wicksipedia Apr 11, 2024
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
25 changes: 15 additions & 10 deletions rules/avoid-using-gendered-pronouns/rule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
---
type: rule
archivedreason:
title: Do you avoid using gendered pronouns?
guid: eebb3e51-9869-4fee-8f99-988bd4467b15
uri: avoid-using-gendered-pronouns
created: 2020-12-21T15:32:54.0000000Z
authors:
- title: Adam Cogan
url: https://ssw.com.au/people/adam-cogan
- title: Matt Goldman
url: https://ssw.com.au/people/matt-goldman
- title: Adam Cogan
url: https://ssw.com.au/people/adam-cogan
- title: Matt Goldman
url: https://ssw.com.au/people/matt-goldman
wicksipedia marked this conversation as resolved.
Show resolved Hide resolved
- title: Matt Wicks
url: https://ssw.com.au/people/matt-wicks
related: []
redirects:
- do-you-avoid-using-gendered-pronouns

- do-you-avoid-using-gendered-pronouns
created: 2020-12-21T15:32:54.000Z
archivedreason: null
guid: eebb3e51-9869-4fee-8f99-988bd4467b15
---

Historically, it’s been the convention to refer to users as ‘he’ in technical documentation. This is obviously outdated and sexist – users may not be a "he". It’s more common now to see "he/she" used, but this is clunky and could also still be considered as misgendering non-binary people.
Expand All @@ -30,7 +31,6 @@ This feature is particularly important if the user runs a semi-long task (e.g.30

::: bad
Bad example: User referred to as "he"

:::


Expand All @@ -41,5 +41,10 @@ This feature is particularly important if the user runs a semi-long task (e.g.30

::: good
Good example: User referred to as "they"
:::

::: info
You can use tools like [Alex](https://alexjs.com) to get better at considerate writing finding potential occurrences with a tool that suggests helpful alternatives.

This can be run as a pull request check as well - [Alex Recommends GitHub Action](https://github.com/marketplace/actions/alex-recommends)
:::
Loading