> For the complete documentation index, see [llms.txt](https://docs.prestashop-project.org/translating-prestashop/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.prestashop-project.org/translating-prestashop/translating-prestashop-software-basics/translating-on-crowdin/the-dos-and-donts-of-crowdin-translation.md).

# The Do's & Don'ts of Crowdin Translation

Here's what you must do and don't when Translating on Crowdin.

## ❌ Don't t**ranslate variables:**

Variables are values that can change depending on their context in the program. They are highlighted in <mark style="color:green;">green</mark> and must **not be translated** as they can result in software bugs, for example.

On Crowdin, you can simply click on a variable to copy and paste it into the target language. Make sure to copy and paste the variable exactly as displayed on the original string.

❌ Don't:

<figure><img src="https://4251351290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZ4zSrJvXs9WU5ydWYb7d%2Fuploads%2FCihgHTFsUJFiaqb0vkEI%2FCapture%20d%E2%80%99e%CC%81cran%202023-05-24%20a%CC%80%2011.25.29.png?alt=media&amp;token=fcac32a5-68d0-4c5a-8d81-d144d1dd06a1" alt=""><figcaption></figcaption></figure>

✅ Do:

<figure><img src="https://4251351290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZ4zSrJvXs9WU5ydWYb7d%2Fuploads%2FplBEmFmPpfwZK6ovfW0F%2FCapture%20d%E2%80%99%C3%A9cran%202022-11-07%20%C3%A0%2014.32.31%20(1).png?alt=media&amp;token=49adeac1-30fb-49b1-90b7-e8a951fd9aac" alt=""><figcaption></figcaption></figure>

## ✅ Use the comments and issue features:

If you don't understand a string and need more context, you can **use the comments section to ask for help**. As this section is visible to every other language in the project, every translator will be able to help you.

### Asking for more context:

You can use the comments section to ask for more context on a string that might seem vague or if you're not sure if the string should be translated or not.

<figure><img src="https://4251351290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZ4zSrJvXs9WU5ydWYb7d%2Fuploads%2FownTc2sd88tfGI7OEonf%2FCapture%20d%E2%80%99e%CC%81cran%202022-11-07%20a%CC%80%2014.55.53.png?alt=media&amp;token=3833a1a9-a5df-4022-ae23-cf15ec9e586a" alt=""><figcaption></figcaption></figure>

Note that you can also check out the [translation domains](/translating-prestashop/resources/resources/useful-websites.md#translation-domains) page to understand where a string is located in the software.

### Requesting the help of a proofreader

[Proofreaders](/translating-prestashop/translating-prestashop-software-basics/translating-on-crowdin/proofreading-all-you-need-to-know.md) ensure the quality of translations. If you wish to improve pre-existing translations, you can do so by requesting their approval.

<figure><img src="https://4251351290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZ4zSrJvXs9WU5ydWYb7d%2Fuploads%2FgocUKTRKdxFWNi7J8b1g%2Fimage.png?alt=media&amp;token=97f87eb4-cd2b-4279-bf90-4f7b8d6d4f7e" alt=""><figcaption></figcaption></figure>

### Reporting a typo

<figure><img src="https://4251351290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZ4zSrJvXs9WU5ydWYb7d%2Fuploads%2FQgJkcWCZOA0nCTYciiIv%2Fimage.png?alt=media&amp;token=3f8b2fe1-6736-42fa-bf2c-4cd440de4a88" alt=""><figcaption></figcaption></figure>

Sometimes, a source string can contain a typo or misspelled word. Simply open an issue on the relevant string by checking the **"issue"** checkbox and the project managers will have a look at your issue.

<figure><img src="https://4251351290-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZ4zSrJvXs9WU5ydWYb7d%2Fuploads%2FIWllDo2tdg4O35DRjGf1%2Fimage.png?alt=media&amp;token=e2ccfa8f-2114-4425-be61-8b881d7ecff8" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.prestashop-project.org/translating-prestashop/translating-prestashop-software-basics/translating-on-crowdin/the-dos-and-donts-of-crowdin-translation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.