agaric/documentation
10
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'stable' of gitlab.com:agaric/documentation into stable

Browse source
This commit is contained in:
benjamin melançon 2020-07-08 13:13:10 -04:00
commit 832c895445
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
content-style-guide.md
View file

@ -1,6 +1,6 @@
# Agaric's Content Style Guide # Agaric's Content Style Guide
This is our company style guide. It helps us write clear and consistent content. Please use it as a reference when you’re writing for Agaric. Adapted from [Mailchimp](https://styleguide.mailchimp.com/) and available under a Creative Commons Attribution-NonCommercial 4.0 International license. This is our company style guide. It helps us write clear and consistent content. Please use it as a reference when you’re writing for Agaric. Adapted from [MailChimp](https://styleguide.mailchimp.com/) and available under a Creative Commons Attribution-NonCommercial 4.0 International license.
## TL;DR ## TL;DR
@ -17,16 +17,16 @@ Good content is:
Agaric’s voice is: Agaric’s voice is:
* Confident but not arrogant * Confident but not arrogant
* Cheerful but not pollyannaish * Cheerful but not Pollyanna-ish
* Unconstrained but not incomprehensible * Unconstrained but not incomprehensible
* Open (curious, eclectic) but not scattered * Open, curious, eclectic, but not scattered
### Writing about people ### Writing about people
We write and build apps with a person-first perspective. Being aware of the impact of your language is one way for us to live out our [values](values). We write and build apps with a person-first perspective. Being aware of the impact of your language is one way for us to live out our [values](values).
* Don’t reference age or disability unless it’s relevant to what you’re writing. * Don’t reference age or ability unless it’s relevant to what you’re writing.
* Avoid gendered language and use the singular “they.” * Avoid gendered language and use the singular “they.”
* When writing about a person, use their preferred pronouns; if you don’t know those, just use their name. * When writing about a person, use their preferred pronouns; if you don’t know those, just use their name.
* Related resource: [The Conscious Style Guide](https://consciousstyleguide.com/). * Related resource: [The Conscious Style Guide](https://consciousstyleguide.com/).
@ -142,9 +142,9 @@ Don’t reference a person’s age unless it’s relevant to what you’re writi
The CEO, 16, just got her driver’s license. The CEO, 16, just got her driver’s license.
Don’t refer to people using age-related descriptors like “young,” “old,” or “elderly.” Don’t refer to people using age-related descriptors like “young,” “old,” or “elderly.”
### Disability ### Ability
Don’t refer to a person’s disability unless it’s relevant to what you’re writing. If you need to mention it, use language that emphasizes the person first: ”she has a disability” rather than “she is disabled.” When writing about a person with disabilities, don’t use the words “suffer,” “victim,” or “handicapped.” “Handicapped parking” is OK. Don’t refer to a person’s ability unless it’s relevant to what you’re writing. If you need to mention it, use language that emphasizes the person first: ”she has a disability” rather than “she is disabled.” When writing about a person with disabilities, don’t use the words “suffer,” “victim,” or “handicapped.” “Handicapped parking” is OK.
### Gender and sexuality ### Gender and sexuality