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

Tighten up intro to styleguide a little but needs overhaul

Browse source
This commit is contained in:
benjamin melançon 2021-12-09 22:21:39 -05:00
parent 1a3925706e
commit b3c09f7857
1 changed files with 5 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
content-style-guide.md
View file

@ -1,19 +1,13 @@
# 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 are writing for Agaric. Please reference this styleguide when writing for Agaric to keep our communications clear and consistent.
## TL;DR ## Summary
The Agaric Content Style Guide goes into depth on many subjects. It may be more information than you need. Here are the most important things to know.
### Principles
Good content is: Good content is:
* Authentic, useful, and appropriate * Authentic, useful, and appropriate
### Voice and tone
Agaric's voice is: Agaric's voice is:
* Confident but not arrogant * Confident but not arrogant
@ -21,13 +15,12 @@ Agaric's voice is:
* 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 language is one way for us to live out our [values](values).
* Do not reference age or ability unless it is relevant to what you’re writing. * Do not reference age or ability unless it is 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 do not know those, use their name. * When writing about a person, use their preferred pronouns; if you do not know those, use their name.
* Related resource: [The Conscious Style Guide](https://consciousstyleguide.com/). * Related resource: [The Conscious Style Guide](https://consciousstyleguide.com/).