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

    Be Translation Friendly¶

    Many readers are not fluent in English and may find some grammatical structures (which are quite popular in English) confusing.

    Rules¶

    • Do not use *multiple attributes* that precede a noun.
    • Do not omit *that* which introduces a subordinate clause.
    • Do not use such forms of expression as jargon or metaphors.
    • Do not use synonyms. Each concept should be referred to by only one term.
    • Reuse terms when referring to the facts you have already stated instead of using pronouns such as it, they, and so on to refer back to them.

    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.