From 80ac6a20b5b81d376e201786d363707925cc2cb7 Mon Sep 17 00:00:00 2001 From: Eric Date: Thu, 6 Jul 2023 22:20:19 -0500 Subject: [PATCH] Handbook: Add sentence case section to company/why-this-way (#12602) closes: #11758 Changes: - Moved the sentence case section from the content style guide to the "Why this way?" page. ... --------- Co-authored-by: Sampfluger88 <108141731+Sampfluger88@users.noreply.github.com> --- handbook/company/why-this-way.md | 12 ++++++++++++ handbook/marketing/content-style-guide.md | 7 ++----- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/handbook/company/why-this-way.md b/handbook/company/why-this-way.md index f9a370208b..c8605541a7 100644 --- a/handbook/company/why-this-way.md +++ b/handbook/company/why-this-way.md @@ -249,5 +249,17 @@ The first step was to add a simpler way to schedule queries, and tuck away the l Packs will always be supported in Fleet. +#### Why does Fleet use sentence case? + +Fleet uses sentence case capitalization for all headings, subheadings, button text in the Fleet product, fleetdm.com, the documentation, the handbook, marketing material, direct emails, in Slack, and in every other conceivable situation. + +In sentence case, we write and capitalize words as if they were in sentences: + +> Ask questions about your servers, containers, and laptops running Linux, Windows, and macOS + +As we use sentence case, only the first word is capitalized. But, if a word would normally be capitalized in the sentence (e.g., a proper noun, an acronym, or a stylization) it should remain capitalized. + +The reason for sentence case at Fleet is that everyone capitalizes differently in English, and capitalization conventions have not been taught very consistently in schools. Sentence case simplifies capitalization rules so that contributors can deliver more natural, even-looking content with a voice that feels similar no matter where you're reading it. + diff --git a/handbook/marketing/content-style-guide.md b/handbook/marketing/content-style-guide.md index ae234a76d0..a039a41c2d 100644 --- a/handbook/marketing/content-style-guide.md +++ b/handbook/marketing/content-style-guide.md @@ -108,12 +108,9 @@ As we use sentence case, only the first word is capitalized. But, if a word woul - "Zach is the co-creator of osquery" - "Does it work with MySQL?" -#### Why sentence case? -The reason for sentence case at Fleet is that everyone capitalizes differently in English, and capitalization conventions have not been taught very consistently in schools. Sentence case simplifies capitalization rules so that contributors can deliver more natural, even-looking content with a voice that feels similar no matter where you're reading it. +> Struggling with this? It takes some adjustment, and you need repetitions of seeing things written this way and correcting yourself. Many contributors have given the feedback that this opinionated solution is a huge relief once you build the habit of using sentence case capitalization, since it frees up mental capacity in every copywriting situation. You don't have to think as hard, nor choose between flouting and laboriously adhering to the (likely somewhat complex and out of date) styleguide. -> Struggling with this? It takes some adjustment, and you need repetitions of seeing things written this way and correcting yourself. Many contributors have given the feedback that this opinionated solution is a huge relief once you build the habit of using sentence case capitalization, since it frees up mental capacity in every copywriting situation. You don't have to think as hard, nor choose between flouting and laboriously adhering to the (likely somewhat complex and out of date) styleguide. - -> TODO: extrapolate the bulk of this whole sentence-case section to "Why this way", since it applies for every department at Fleet +You can read about why we use sentence case in ["📖Company/Why this way?"](https://fleetdm.com/handbook/company/why-this-way.md#why-does-fleet-use-sentence-case). ### Contractions They’re great! Don’t be afraid to use them. They’ll help your writing sound more approachable.