Start tightening up, fixing links
This commit is contained in:
parent
b434c2d8ee
commit
9e688c30eb
1 changed files with 7 additions and 2 deletions
|
@ -1,4 +1,4 @@
|
|||
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. For now, it has been heavily lifted from <a href="https://styleguide.mailchimp.com/">Mailchimp</a>.
|
||||
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 <a href="https://styleguide.mailchimp.com/">Mailchimp</a> and available under a Creative Commons Attribution-NonCommercial 4.0 International license.
|
||||
|
||||
This guide goes beyond basic grammar and style points. It’s not traditional in format or content. We break a number of grammar rules for clarity, practicality, or preference.
|
||||
|
||||
|
@ -8,18 +8,23 @@ This guide goes beyond basic grammar and style points. It’s not traditional in
|
|||
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:
|
||||
|
||||
* Authentic, Useful and Appropriate
|
||||
|
||||
### Voice and tone
|
||||
|
||||
Agaric’s voice is:
|
||||
|
||||
* Confident but not arrogant
|
||||
* Cheerful but not pollyannaish
|
||||
* Unconstrained but not incomprehensible
|
||||
* Open (curious, eclectic) but not scattered
|
||||
|
||||
### 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 <a href="https://gitlab.com/agaric/internal/wikis/values">values</a>.
|
||||
|
||||
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.
|
||||
* Avoid gendered language and use the singular “they.”
|
||||
|
|
Loading…
Reference in a new issue