Skip to content
logo
Percona Documentation Style Guide
Word usage
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
        • Rules
      • Numbers
    • Writing
      • Rules for specific documentation types
    • Guidelines
    • Markup
    • Copyright and licensing
    • Trademark policy
    • Rules

    Word usage¶

    Rules¶

    • Use enable instead of allow. Allowing is about giving permission. (Example: This feature enables you to …)
    • Do not refer to images, tables, examples, lists using above and below. Use the following table and in the previous example.
    • One word are: metadata, timestamp, filesystem
    • Use As of version instead of Starting from or another form. (Example: As of version 5.7, this variable is no longer available.)

    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.