From 1940b348fb9e88d14330720a80d4d50db5ccf151 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 17 Apr 2023 12:49:15 -0700 Subject: [PATCH] Add voice & tone info from brand guide to style guide (#36408) --- contributing/content-style-guide.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index d808410a78..f2addaa5c6 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -231,7 +231,7 @@ To learn about creating and versioning images, see "[Creating and updating scree ## Inclusive language -As home to the largest developer community in the world, GitHub is committed to promoting diversity and inclusion in every aspect of what we do. It is critical that all of our documentation is inclusive and respectful of our audience, which consists of people in widely varying circumstances from all over the planet. When we write our documentation, we use words that are inclusive, anti-racist, and accessible. +As home to the largest developer community in the world, GitHub is committed to promoting diversity and inclusion in every aspect of what we do. All of our documentation is inclusive and respectful of our audience, which consists of people in widely varying circumstances from all over the planet. When we write our documentation, we use words that are inclusive, anti-racist, and accessible. Individual words might be small, but together they can create community, belonging, and equity. Be empathetic in all word and style choices. Be accurate when referring to people and communities. @@ -830,7 +830,13 @@ Videos on the GitHub Docs website must be well-produced and accessible, and conf ## Voice and tone -Use clear, simple language that’s approachable and accessible for a wide range of readers. To learn more about writing approachable content, see “[Microsoft's brand voice: Above all, simple and human](https://docs.microsoft.com/style-guide/brand-voice-above-all-simple-human) and “[Top 10 tips for Microsoft style and voice](https://docs.microsoft.com/style-guide/top-10-tips-style-voice).” +Use clear, simple language that’s approachable and accessible for a wide range of readers. Be authentic, empathetic, and confident with your writing. + +Write for your audience: some jargon and technical terms are necessary, but don't rely on the assumption that every reader has the same level of technical expertise. + +We are a global developer community. Avoid turns of phrase, idioms, and slang that are specific to a particular region or country. + +To learn more about writing approachable content, see “[Microsoft's brand voice: Above all, simple and human](https://docs.microsoft.com/style-guide/brand-voice-above-all-simple-human) and “[Top 10 tips for Microsoft style and voice](https://docs.microsoft.com/style-guide/top-10-tips-style-voice).” ## Word choice and terminology @@ -943,10 +949,6 @@ Where the first reference concerns `cents` or a non-dollar amount, capitalize th - **Use:** `99 cents (US currency)` for the first reference, and `99 cents` for subsequent references. - **Avoid:** `$0.99 (US currency)`, `$0.99 USD cents`, `USD$0.99 cents`. -### Inclusive language - -See the “Inclusive language” section of this guide. - ### Permissions A **permission** is the ability to perform a specific action. For example, the ability to delete an issue is a permission.