Skip to content
logo
Percona Documentation Style Guide
Headings
Initializing search
    percona/doc-style-guide
    percona/doc-style-guide
    • Home
    • Storytelling
      • Voice and Tone
      • Keep the Structure Simple
      • Use Cross-References Appropriately
    • Text
      • Hyphens
      • Paragraphs
      • Lists
      • Headings
      • Tables
      • Graphics
      • Callouts and admonitions
      • Code descriptions
      • SQL statement conventions
      • Links
      • Legal information
      • None
    • Grammar
      • Capitalization
      • Punctuation
      • Spelling
      • Word usage
      • Numbers
    • Writing
      • Rules for specific documentation types
    • Guidelines
    • Markup
    • Copyright and licensing
    • Trademark policy

    Headings¶

    Use the imperative mood.

    Write titles using short, descriptive words

    Focus on what the user can do rather than describe a feature

    Rules

    • Do not use stacked headings: a subsection heading immediately following a section heading
    • Avoid using one or two-word headings
    • Write brief but descriptive headings
    • Keep the structure of headings of the same level grammatically aligned
    • Avoid formatting headings (italic, bold, underlined, etc.) and using abbreviations (because they should be introduced first)
    • Don’t end headings with a period or a colon
    • There should be only one H1 in the document

    Contact Us

    For free technical help, visit the Percona Community Forum.

    To report bugs or submit feature requests, open a JIRA ticket.

    For paid support and managed or consulting services , contact Percona Sales.


    Last update: June 26, 2023
    Created: June 26, 2023
    Percona LLC and/or its affiliates, © 2023
    Made with Material for MkDocs

    Cookie consent

    We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better. Read more about Percona Cookie Policy.