Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-24 09:28:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 31

Handbook: Add sentence case section to company/why-this-way (#12602)

Browse source 
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>
This commit is contained in:
Eric 2023-07-06 22:20:19 -05:00 committed by GitHub
parent 6ef10b39ae
commit 80ac6a20b5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
handbook/company/why-this-way.md
View file

@ -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.
<meta name="maintainedBy" value="mikermcneil">
<meta name="title" value="Why this way?">

7
handbook/marketing/content-style-guide.md
View file

@ -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.