Common Style Guidelines
This section includes guidelines for preventing common errors in word choice and sentence formation in accordance with vendors requirements.
This section includes guidelines for preventing common errors in word choice and sentence formation. The list contains some of the most common errors in grammar, language, style, and formatting. Use this section as a quick reference as you write or edit. For more comprehensive information on, and guidelines for writing about technical information, please see the each vendors Manual of Style to remain compliant with accessibility requirements.
The term, acronym, is used when the letters can be pronounced as a word. Initialism is the correct term to use when the first letters cannot be pronounced as a word. HOL or ILL can be either.
Spell these out at first mention, for example: System Center Virtual Machine Manager (VMM). Note that, in this example, the Microsoft initialism is VMM, not SCVMM. One often sees both, but by visiting Microsoft Docs pages, you can see that the correct initialism is VMM.
You can usually confirm trademarks using different vendors websites.
In this document style, only UI elements that a user interacts with should be bold. Ensure that the UI element is bold, but any punctuation following the UI term is not bold.
It is acceptable to miss a period at the end of a sentence if it ends with a password such as:
Enter the following password &s6&90saiis9*
Initial caps mean capitalising the first letter of a word. Use initial caps for:
- File names. Internal caps are OK for readability, as in MyFile.doc. The file extension should be lowercase. Examples: MyTaxFile.doc, Oleaut.dll.
- Agenda items in slide presentations
- Folder names (internal caps are OK for readability)
- Mode names (Break mode)
- Named views (Gantt view)
- Named windows (the Edit window)
- Proper names (the Insert menu)
- “Wizard” when used as part of a proper name of a wizard (for example, the Answer Wizard)
In sentence case, you capitalise only the first letter in a sentence or phrase. Use sentence case for all task titles.
Use this for the exercise titles and lab titles.
- Capitalise all nouns, verbs (including is and other forms of be), adverbs (including than and when), adjectives (including this and that), and pronouns (including its).
- Capitalise the first and last words, regardless of their parts of speech ("The Text to Look For").
- Capitalise prepositions that are part of a verb phrase ("Backing Up Your Disk").
- Do not capitalise articles (a, an, the) unless the article is the first word in the title.
- Do not capitalise coordinate conjunctions (and, but, for, nor, or, yet, so) unless the conjunction is the first word in the title.
- Do not capitalise prepositions of four or fewer letters unless the preposition is the first or the last word in the title.
- Do not capitalise “to” in an infinitive phrase ("How to Format Your Hard Disk") unless the phrase is the first word in the title.
- Capitalise the second part of a hyphenated compound if it would be capitalised without the hyphen. Always capitalize the second part of a hyphenated compound if it is the last word of a heading or title.