Skip to content

Commit

Permalink
Handbook: Update note about sentence case + step numbers (#25415)
Browse files Browse the repository at this point in the history
Discussed w/ @noahtalerman, concluded that capitalization makes sense in
this case.
  • Loading branch information
rachaelshaw authored Jan 15, 2025
1 parent cefabf9 commit 5d1839a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion handbook/company/why-this-way.md
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ 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. User roles (e.g., "observer" or "maintainer") and features (e.g. "automations") in the Fleet product aren't treated as proper nouns and shouldn't be capitalized. Words/phrases that follow steps numbers (e.g. "Step 1: create") in the documentation shouldn't be capitalized.
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. User roles (e.g., "observer" or "maintainer") and features (e.g. "automations") in the Fleet product aren't treated as proper nouns and shouldn't be capitalized. However, words/phrases that follow step numbers in the documentation _should_ be capitalized (e.g. "Step 1: Create"), since the step number is merely acting as a label for the phrase that follows.

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.

Expand Down

0 comments on commit 5d1839a

Please sign in to comment.