Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review sections on capitalisation #415

Open
daobrien opened this issue Oct 12, 2022 · 1 comment
Open

Review sections on capitalisation #415

daobrien opened this issue Oct 12, 2022 · 1 comment
Labels
enhancement Will improve the guide but is not a bug or blocker.
Projects

Comments

@daobrien
Copy link
Collaborator

We should review our guidance to take into account the following from the Corporate guide:

capitalization

If it's not the official name of a Red Hat offering (with a SKU) or department, don't capitalize it (even if it seems important).
Capitalize job titles. Example: "Bob Smith, Group Manager, Acme Widgets" or "Acme Widgets Group Manager Bob Smith."
Do not capitalize job personas. See also department names, commands, personas.
Do not capitalize domain names, even when they begin a sentence (but try to avoid starting a sentence with a domain name). Example: "redhat.com is awesome." When writing a domain name that does not belong to Red Hat, adhere to that entity's capitalization. If you can't determine how they capitalize it, default to Red Hat's style. Keep in mind that screen readers may have trouble speaking domain names with more than 1 word. Use good judgment in deciding how to write multiword domain names; if needed for clarity, use CamelCase. See also URLs.

department names

The preferred word is "team," regardless of size or function. Do not use "business unit" in external-facing documents. Use "organization" to distinguish a department from its subteams or otherwise call attention to its large, multiteam nature: "The OpenShift Engineering team is part of the Red Hat Engineering organization."
When displayed as a title or caption, capitalize all words including team or organization: "Red Hat Finance Team," "Red Hat IT Organization"
When using in context or in a sentence, don't capitalize words like team or organization: "As a member of the Red Hat Finance team...," "...with our Global Workplace Solutions team."

commands (Needs a new title)
(This is quite different from CMOS and the examples in this section in the Corp guide really need updating.)

Many proper nouns and other words, especially commands and names of open source projects, begin with a lowercase letter. How should those words be treated when they begin a sentence? AP Style guidance:

For words like iPad or iPod, AP Style recommends that they be styled with an uppercase letter when beginning a sentence. So "IPads are selling poorly in Q4" or "IPods are no longer the best-selling holiday item now that people listen to music on their phones."
AP Style has no guidance for command names. However, Linux makes distinctions based on capitalization that would make a capitalized command incorrect. For example, with "ls" and "Ls"—a user reading a document, blog post, or other material where the command name has been capitalized may have reason to expect they could use Ls but that will be met with an error.

@daobrien daobrien added P2 Should address this soon. enhancement Will improve the guide but is not a bug or blocker. labels Oct 12, 2022
@daobrien daobrien self-assigned this Oct 12, 2022
@daobrien daobrien added this to To do in 6.0 via automation Oct 12, 2022
@daobrien daobrien removed their assignment Feb 13, 2023
@daobrien daobrien removed the P2 Should address this soon. label Feb 13, 2023
@daobrien
Copy link
Collaborator Author

We probably need to decide how much of this we want to integrate into the RH Guide. The "department names" section, in particular, might not need inclusion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Will improve the guide but is not a bug or blocker.
Projects
No open projects
6.0
To do
Development

No branches or pull requests

1 participant