Skip to content
logo
Percona Documentation Style Guide
Documentation Style Guide
percona/doc-style-guide
percona/doc-style-guide
  • Home
    • Be Translation Friendly
    • 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 Guidelines
    • Capitalization
    • Punctuation
    • Spelling
    • Word usage
    • Numbers
    • Naming files for SEO
    • Rules for specific documentation types
    • Release notes structure guidelines
    • Markup
    • Copyright and Licensing Information
    • Trademark Policy

Documentation Style Guide¶

This style guide enables implementing the principle of simple documentation. While there may be different ways to understand what simple documentation is, this style guide sticks to the following definition:

Simple documentation is a source of information about a software product which enables the target audience to use the product effectively and efficiently, discover new features, and easily locate all available information about the topics they are interested in by using their own language.

This definition implies that the documentation is perceived by the target audience to be simple. The structure and underlying routines, however, may be as complex as necessary.

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