Headings
Headings help readers scan and find information quickly. Follow these conventions for all documentation headings.
Capitalization
Use sentence case for all headings. Capitalize only the first word and proper nouns.
| Correct | Incorrect |
|---|---|
| Configure the application | Configure The Application |
| Set up your API keys | Set Up Your API Keys |
Hierarchy
Use heading levels in order. Do not skip levels (for example, do not jump from ## to ####).
Parallel structure
When sibling headings describe similar actions, use the same grammatical form. For example, start all headings with a verb: “Create a project,” “Configure settings,” “Deploy the application.”