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

    Paragraphs¶

    A complicated syntax structures require additional effort to comprehend.

    Rules¶

    • Break up long paragraphs (longer than 3-7 lines)
    • Make your text scannable: add sections, break paragraphs into lists
    • Do not use sentences with more than two clauses. Put conditional clauses before the instructions (e.g. For more information, see [link to the document])
    • Organize sentences in an intuitive manner. Move from common to specific, from known to unknown.

    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: February 10, 2023
    Created: February 10, 2023
    Percona LLC and/or its affiliates, © 2023
    Made with Material for MkDocs