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 |
---|---|
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). |
|
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:
|
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