From b3c09f78572871817f8bd19ef0e01f5c5d2169b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Melan=C3=A7on?= Date: Thu, 9 Dec 2021 22:21:39 -0500 Subject: [PATCH] Tighten up intro to styleguide a little but needs overhaul --- content-style-guide.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/content-style-guide.md b/content-style-guide.md index 47676c1..2a51a7d 100644 --- a/content-style-guide.md +++ b/content-style-guide.md @@ -1,19 +1,13 @@ # 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 - -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 +## Summary Good content is: * Authentic, useful, and appropriate -### Voice and tone - Agaric's voice is: * Confident but not arrogant @@ -21,13 +15,12 @@ Agaric's voice is: * 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 [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. -* Avoid gendered language and use the singular “they.” +* Do not reference age or ability unless it is relevant to what you're writing. +* 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. * Related resource: [The Conscious Style Guide](https://consciousstyleguide.com/).