# Documentation Style Guide

## Style Guide

**We adhere to the** [**Google developer documentation style guide**](https://developers.google.com/style/)**.** Here are some links to particularly important resources from that style guide:

* [Word list](https://developers.google.com/style/word-list) – an alphabetically ordered list that allows you to quickly find words to use, or not to use, and recommendations of words and terms to use.
* [Accessibility](https://developers.google.com/style/accessibility) – write inclusive documentation for a global audience.
* [Timeless documentation](https://developers.google.com/style/timeless-documentation) – avoid words and terms like *currently*, *existing*, *in the future*, *now*, or *soon*.
* [Capitalization](https://developers.google.com/style/capitalization) – when to use the Shift key, and how to format [headings and titles](https://developers.google.com/style/headings). **We use upper case for headings**, which is about the only deviation from the Google style guide.
* [Abbreviations](https://developers.google.com/style/abbreviations) – how to use acronyms and initialisms.
* [Punctuation](https://developers.google.com/style/colons) – how to properly use colons, commas, dashes, etc.
* [Formatting and organization](https://developers.google.com/style/dates-times) – how to write dates and times, headings and titles, when to use [lists](https://developers.google.com/style/lists) or rather [tables](https://developers.google.com/style/tables).
* [Cross-references](https://developers.google.com/style/cross-references) – how to properly write links.
* [Code samples](https://developers.google.com/style/code-samples) – how to write and format code blocks.
* [Example domain names, IP numbers, and person names](https://developers.google.com/style/examples) – and how to use filenames and trademarks.

## Additional Information

**Version-specific information:** We refer to software versions (like "MariaDB 10.6") only for products (like MariaDB Server or MaxScale) or features (like replication or authentication) that follow the **`N-1` rule**, where `N` is the last version still under maintenance. (At the time of writing, that's MariaDB 10.6 for the Server.) In other words, we'd mention MariaDB 10.5, but not versions older than that.\
This is the principle, from which we will deviate if there's a valid reason to do so.

{% @marketo/form formId="4316" %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://mariadb.com/docs/general-resources/about/readme/documentation-style-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.