Headings

Use headings and subheadings to organize content into sections and help users find specific information.

When creating a heading, follow the next principles:

Capitalize

Do Not Capitalize

All adjectives, adverbs, nouns and verbs.

The preposition to, unless it is the first word in the heading.

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 and less.

Hyphenated compound words (for example, On-Demand Sandbox).

Case-sensitive words (for example, command line commands).

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.

All subject and object pronouns (I, me, you, he, him, she, her, it, we, us, they, them), including possessive adjectives (my, your, his, her, its, our, their).

 

 

Headings Important

The only exception from 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:

  • Capitalize only the first word in each subheading.
  • Use articles in case they help you avoid misunderstanding. For example, The most recent restore point will be used if multiple backups or replicas of a VM exist.

Examples

  1. Step 1. Launch a New Backup Copy Job Wizard
  2. Step 12. Finish Working with the Wizard
  3. Getting to Know Veeam Backup & Replication
  4. Backup and Replication
  5. Installing Updates in Unattended Mode
  6. /backupServers/{ID}/credentials
  7. Find-VBRViEntity
  8. Scale-Out Backup Repositories
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.