Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
Developer Documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
brienne
Developer Documentation
Commits
b3fe07e0
Commit
b3fe07e0
authored
8 years ago
by
Sean Madsen
Browse files
Options
Downloads
Patches
Plain Diff
Style guide: adding guidelines for gender neutral language
parent
135e34fe
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/best-practices/documentation-style-guide.md
+39
-1
39 additions, 1 deletion
docs/best-practices/documentation-style-guide.md
with
39 additions
and
1 deletion
docs/best-practices/documentation-style-guide.md
+
39
−
1
View file @
b3fe07e0
...
...
@@ -148,11 +148,49 @@ Below are our preferred spellings of CiviCRM-specific words:
-
In other guides - refers to the
[
core team
](
https://civicrm.org/teams/core-team
)
### Gender neutrality
When describing people in examples, avoid using pronouns that assign specific
genders to them.
Example of gendered language to avoid:
> *When a supporter wishes to fundraise on behalf of an organization, **he** can
> create a fundraising page **himself**, called a Personal Campaign Page, and
> then solicit donations from **his** friends and family. After a donation
> arrives, CiviCRM can even send **him** a notification email.*
Option 1 - fix by using [singular they]
*
(which is
[
rapidly
](
https://www.washingtonpost.com/news/wonk/wp/2016/01/08/donald-trump-may-win-this-years-word-of-the-year/
)
[
gaining
](
http://www.americandialect.org/2015-word-of-the-year-is-singular-they
)
[
popularity
](
http://www.npr.org/2016/01/13/462906419/everyone-uses-singular-they-whether-they-realize-it-or-not
)
)
*
:
> *When a supporter wishes to fundraise on behalf of an organization, **they**
> can create a fundraising page **themself**, called a Personal Campaign Page,
> and then solicit donations from **their** friends and family. After a donation
> arrives, CiviCRM can even send **them** a notification email.*
Option 2 - fix by avoiding pronouns entirely:
> *A supporter wishing to fundraise on behalf of an organization can
> autonomously create a fundraising page, called a Personal Campaign Page, and
> then solicit donations from friends and family. After a donation arrives,
> CiviCRM can even send **the supporter** a notification email.*
Avoid fixing gendered language by replacing "he" with phrases such as:
"he/she", "he or she", "she", or "s/he". Such replacements (a) become more
awkward when sentences include multiple pronouns, (b) do not intuitively offer
a consistent choice among them, and (c) fail to acknowledge that some people
identify with genders outside of a binary framework.
[
singular they
]:
https://en.wikipedia.org/wiki/Singular_they
### Tone and vocabulary
**
For the
*User*
and
*Administrator*
Guides only:
**
We try and limit the
content to tasks that the user can perform from the front end. This means that
we don't go into detail
s
steps about installation or system administration
we don't go into detail
ed
steps about installation or system administration
tasks. We do however let people know that there are system administrator tasks
out there (setting up an SSL certificate, configuring CiviMail etc.) and point
them in the right direction when they want to know about those tasks.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment