Headings
Use headings and subheadings to organize content into sections and help users find specific information.
When creating a heading, follow the next principles:
- Include keywords from the associated paragraphs.
- Keep the heading short — try to use 4–8 words maximum.
- Capitalize words in the heading according to the following rules:
|
Capitalize |
Do Not Capitalize |
|---|---|
|
The first and the last word in the heading, regardless of the part of speech. |
The preposition to, unless it is the first or the last word in the heading. |
|
All nouns, subject and object pronouns (you, we, us, they, them, it), verbs, adverbs and adjectives, including possessive adjectives (your, our, their, its). Note: In Veeam technical documentation, we do not use first-person pronouns (I, me, my) or gendered pronouns (he, she, his, her) in headings. |
Case-sensitive words, even if they are nouns or verbs (for example, command line commands). |
|
Adverbs that are part of phrasal verbs (for example, Back Up, Log In, Set Up). |
Prepositions that link phrasal verbs to their objects (for example, Log In to Microsoft 365), unless a preposition is the last word in the heading (for example, Select Server to Log In To). |
|
All subordinating conjunctions (although, since, if, before, after, unless, until, for (to), as, though, that, once, when, while, because). |
All coordinating conjunctions (and, or, nor, but, for, yet, so), unless a conjunction is the first word in the heading. |
|
All prepositions that contain more than 4 letters. |
All prepositions that contain 4 letters or fewer, unless a preposition is the first or the last word in the heading. |
|
Parts of hyphenated compound words that must be capitalized according to the rules listed in this table (for example, On-Demand Sandbox, Scale-Out Backup Repository). |
Parts of hyphenated compound words that must not be capitalized according to the rules listed in this table (for example, Point-in-Time Restore). |
|
The negative quantifier no and the negative adverb not. |
All articles (a, an, the), unless an article is the first word in the heading. Note: In Veeam technical documentation, we do not use articles in headings. |
Important |
|
The only exception to the listed capitalization rules are Release Notes documents where only topic headings are capitalized according to the rules: System Requirements, Required Permissions, New in This Release, Known Issues and Limitations and Technical Documentation References. All subheadings that introduce new features and list known issues must be capitalized according to the following principles:
|
Examples
- Step 1. Launch a New Backup Copy Job Wizard
- Step 12. Finish Working with the Wizard
- Getting to Know Veeam Backup & Replication
- Backup and Replication
- Installing Updates in Unattended Mode
- /backupServers/{ID}/credentials
- Find-VBRViEntity
- Scale-Out Backup Repositories
- Specifying Directories to Back Up
- Publishing Point-in-Time State