Skip to content
logo
Percona Documentation Style Guide
Lists
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
        • Rules
      • 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
    • Rules

    Lists¶

    Lists are used to organize information with a common subject or in a particular sequence.

    Rules¶

    • Each list has an introductory sentence/paragraph. The introductory sentence can be either a complete sentence or a partial sentence. End the introductory sentence with a colon.

    • Align the grammatical structure of every item in a list. For example, start each item with a noun or a verb. Avoid using an article.

    • Make lists 2-7 items long. Transform shorter lists into paragraphs. Split too-long lists into several lists.

    • A multilevel list may not have more than two levels of nesting. The shortest sub-list is allowed to consist of two items at least.

    • A multilevel list should be balanced where each list item has a similar number of sub-items.

    • Avoid inline lists unless you enumerate simple known facts. Inline lists should not contain more than five items.

    • Use sentence punctuation if every item in a list is a sentence.

    • Do not use any punctuation, such as commas or semicolons, if list items are not sentences.

    • Use numbered lists if the order of items matters.

    • Use bullet lists if the order of items does not matter.

    • Use numbered lists if in doubt.

    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.