Translation and Review Guidelines: Difference between revisions

From Localization Lab Wiki
Jump to navigation Jump to search
(Updating with AO suggestions)
No edit summary
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__TOC__
'''Please review the tips and guidelines below prior to localizing projects. The following information will help you navigate the Weblate interface and more effectively and accurately translate and review projects.'''
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
|
|
'''Communicate with other translators and reviewers using [https://docs.transifex.com/translation/tools-in-the-editor#comments comments]''' if there is any confusion about a translation, terminology choices, or what the original source text means. '''Mention the contributor's name (@username) to make sure the relevant people are notified.''' If you do not mention a contributor's username in a comment or issue, they will not be notified.
===Translation and Review Workflow Policy===
:To ensure the highest level of quality and impartiality in our projects, we follow a double-blind workflow.  
:This means that no single contributor is permitted to perform both the translation and the review of the same string or content.
:The translator's work is independently reviewed by a separate individual to ensure accuracy, consistency, and adherence to project-specific guidelines.  
:This two-person process is a core component of our quality assurance and is a requirement for all Localization Lab projects.
|}
|}
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
|
|
'''Create an [https://docs.transifex.com/translation/tools-in-the-editor#issues issue] if there is a fundamental problem with a string''' that impedes translation or needs to be changed. This will notify the developer and Localization Lab staff that there is a problem that needs to be resolved.
===Machine Translation and AI Assistance===
:We follow a "human-first" approach. Do not submit raw, unedited machine translations or AI outputs as final work. We expect human translation first - any AI or machine translation tools must be strictly supplemental, heavily reviewed, and validated by a fluent human speaker before being added to the target-language area, no matter what platform is being used or what project is being localized.
 
:Please note that our Weblate platform does not integrate AI or MT plugins. Any use of these tools occurs entirely off-platform at your own discretion.


There are several priority levels to chose from when creating an issue:
:If you heavily rely on an external AI assistant to draft a translation, you must leave a comment on the specific string in Weblate (e.g., "Drafted with AI assistance") so reviewers can apply extra scrutiny. Never include tags or notes inside the actual translation text, as this will break the software code.
*'''Low:''' Minor and cosmetic changes to a source string.
|}
* '''Normal:''' Typos, questions or changes affecting the meaning of a source string that may hinder translation.
 
* '''High:''' Significant issues with the localizability or coherence of the source string.
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"
* '''Critical:''' Issues with the source string that might break the software.
|
===Communicate===
:'''''Leave '''[https://docs.weblate.org/en/latest/user/translating.html#comments Comments]''' for other translators'''''
::Localization is a group effort. If you fix a minor typo, make the change directly. If you change key terminology or structure, leave a comment explaining the change and tag the previous translator using @username. This ensures others understand your edits and can learn from them.
::Leaving comments ensures that other contributors understand why you have made changes, can learn from them, and can make sure to apply the changes to future translations.
:'''Report issues to project maintainers:''' If you need more context or spot a fundamental issue with the source text, let the maintainer know. Use the "Comments" tab in Weblate to start a discussion or report an issue with the source string so developers are notified.
|}
 
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"
|
===Read the ''Developer Notes'' and ''Context''===
:Developer notes and context are located in the "Source string info" section or "Context" tab in the Weblate editor. Always read and follow these instructions for the string you are translating.
|}
|}
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
|
|
'''Pay attention to references to settings and buttons in other operating systems or pieces of software''' (i.e. iOS or Android) and be sure to use the translation used in those apps / operating systems.<br><br>''Example:'' If the string refers to the Android OS "Settings", make sure the translations corresponds with the Android OS translation.<br><br>Similarly, if the app refers to "Settings" or "Send" etc. in its own interface, make sure the translation is the same across the application.
===Do Not Translate or Transliterate Application or Project Names===
:Do not translate or transliterate project, company or application names that do not have an official or widely adopted regional variation.
 
:Some projects have widely used and accepted translations or transliterations of their names. If this is the case in your language, feel free to use the localized version.
::'''Example:''' تويتر (''Transliteration of Twitter in Arabic'')
|}
|}
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
|
|
'''Use the [https://docs.transifex.com/translation/using-the-glossary glossary]!''' Reference the glossary (and [https://docs.transifex.com/translation/using-translation-memory-and-concordance-search#concordance-search Concordance Search]) to make sure you are using the correct terms. Input terms into the glossary as often as possible to help maintain consistency and quality of translations.
===Focus on Consistency===
:Ensure translations for recurring terminology and duplicate strings are consistent across a project. Weblate provides features to help manage consistency:
:'''Search:''' Use the search bar to find words and phrases across components and projects.
:'''Translation Memory:''' The "Translation memory" tab in the editor shows how similar strings were translated previously.
:'''Glossary:''' The "Glossary" tab displays approved translations for key terms. If a term is missing, Reviewers can add it directly to the glossary.
|}
|}
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
|
|
Remember that the '''product name should not be translated or transliterated''' for this project unless you think it is necessary for users to understand, in which case you can follow the unique instructions for each on the [[projects]].
===Watch Out for Placeholders, HTML, and Markup===
:'''Placeholders and variables:''' Strings often contain placeholders (e.g., %s, {user}) replacing dynamic content. Keep these unchanged. You can move them to where they make grammatical sense in your target language. If you are unsure what a placeholder represents, check the context or ask the maintainer.
:'''HTML and Unicode entities:''' Keep HTML entities (e.g., &nbsp;, &lt;) exactly as they appear in the source, or replace them with their corresponding character if appropriate.
:'''New lines:''' Ensure your translation has the exact same number of new lines (\n) as the English source text.
|}
|}
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
|
|
'''Read the "[https://docs.transifex.com/translation/tools-in-the-editor#string-instruction-and-developer-notes String Instructions]" and "[https://docs.transifex.com/translation/tools-in-the-editor#string-instruction-and-developer-notes Developer Notes]"''' for each string. They contain valuable information about how to translate the string.
===Pay Attention to Read-Only and Failing Checks===
:Some strings are marked as read-only or flagged to be ignored. Do not force translations on these. Weblate has built-in quality checks that will trigger a ''failing check'' warning if your translation mismatches the source format, variables, or punctuation. Always review and resolve these warnings.
|}
|}
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
|
|
'''If a string is tagged as "[https://docs.transifex.com/projects/preventing-resource-edits#locking-strings notranslate]" or "[https://docs.transifex.com/projects/preventing-resource-edits#locking-strings locked]", do not translate the string.''' [https://docs.transifex.com/translation/translating-with-the-web-editor#shortcut-buttons Copy] the exact string from the original source.
===Punctuation, Capitalization, Double Spaces, and Typos===
:Small details matter. An inconsistent interface reduces user trust. While translating and reviewing, ensure you:
::Use correct and consistent punctuation.
::Use correct capitalization. Match the English source unless your language rules dictate otherwise.
::Add the correct number of brackets and parentheses.
::Do not add double spaces unless present in the original source. Weblate will flag trailing or multiple spaces as a failing check.
|}
|}
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
|
|
'''Use the "[https://docs.transifex.com/translation/using-translation-memory-and-concordance-search#concordance-search Concordance Search]" and the [https://docs.transifex.com/translation/translating-with-the-web-editor#searching-and-filtering-for-strings search filters]''' to double check that your translations are consistent in terminology, style and tone.
===Reference Other Languages===
:If you are multilingual, you can view current translations in other languages to better understand the context. Use the "Other languages" tab in the Weblate editor. Remember to ultimately defer to the English source text, as other translations may not be fully reviewed.
|}
|}
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
|
|
'''Use the ''[https://docs.transifex.com/translation/using-translation-memory-and-concordance-search#understanding-translation-memory-suggestions Suggestions]'' tab in the web editor''' to view translations of other strings and resources in related projects. Translations of strings which are up to 60% the same will appear in this tab. Referencing these suggestions will help you maintain consistency across projects.
===Always Keep the End User in Mind===
:Ask yourself if a non-technical user would understand your translation without help. The goal is to make the text understandable and culturally appropriate, rather than translating literally.
|}
|}
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;"  
|
|
'''Be aware of [https://docs.transifex.com/translation/html-files variables and placeholders]!''' Make sure you maintain variables in the translated text, but feel free to move them around as necessary in your language's grammar.
===Know the Style Guide===
:Check to see if there is a style guide for [https://wiki.localizationlab.org/index.php/Language_Resources your language] on this wiki.
 
:No style guide on the Localization Lab wiki for your language team? Refer to [https://wiki.localizationlab.org/index.php/Language_Resources#Multi-Lingual_Style_Guides style guides for other technical projects].
|}
|}

Latest revision as of 01:49, 27 February 2026

Please review the tips and guidelines below prior to localizing projects. The following information will help you navigate the Weblate interface and more effectively and accurately translate and review projects.

Translation and Review Workflow Policy

To ensure the highest level of quality and impartiality in our projects, we follow a double-blind workflow.
This means that no single contributor is permitted to perform both the translation and the review of the same string or content.
The translator's work is independently reviewed by a separate individual to ensure accuracy, consistency, and adherence to project-specific guidelines.
This two-person process is a core component of our quality assurance and is a requirement for all Localization Lab projects.

Machine Translation and AI Assistance

We follow a "human-first" approach. Do not submit raw, unedited machine translations or AI outputs as final work. We expect human translation first - any AI or machine translation tools must be strictly supplemental, heavily reviewed, and validated by a fluent human speaker before being added to the target-language area, no matter what platform is being used or what project is being localized.
Please note that our Weblate platform does not integrate AI or MT plugins. Any use of these tools occurs entirely off-platform at your own discretion.
If you heavily rely on an external AI assistant to draft a translation, you must leave a comment on the specific string in Weblate (e.g., "Drafted with AI assistance") so reviewers can apply extra scrutiny. Never include tags or notes inside the actual translation text, as this will break the software code.

Communicate

Leave Comments for other translators
Localization is a group effort. If you fix a minor typo, make the change directly. If you change key terminology or structure, leave a comment explaining the change and tag the previous translator using @username. This ensures others understand your edits and can learn from them.
Leaving comments ensures that other contributors understand why you have made changes, can learn from them, and can make sure to apply the changes to future translations.
Report issues to project maintainers: If you need more context or spot a fundamental issue with the source text, let the maintainer know. Use the "Comments" tab in Weblate to start a discussion or report an issue with the source string so developers are notified.

Read the Developer Notes and Context

Developer notes and context are located in the "Source string info" section or "Context" tab in the Weblate editor. Always read and follow these instructions for the string you are translating.

Do Not Translate or Transliterate Application or Project Names

Do not translate or transliterate project, company or application names that do not have an official or widely adopted regional variation.
Some projects have widely used and accepted translations or transliterations of their names. If this is the case in your language, feel free to use the localized version.
Example: تويتر (Transliteration of Twitter in Arabic)

Focus on Consistency

Ensure translations for recurring terminology and duplicate strings are consistent across a project. Weblate provides features to help manage consistency:
Search: Use the search bar to find words and phrases across components and projects.
Translation Memory: The "Translation memory" tab in the editor shows how similar strings were translated previously.
Glossary: The "Glossary" tab displays approved translations for key terms. If a term is missing, Reviewers can add it directly to the glossary.

Watch Out for Placeholders, HTML, and Markup

Placeholders and variables: Strings often contain placeholders (e.g., %s, {user}) replacing dynamic content. Keep these unchanged. You can move them to where they make grammatical sense in your target language. If you are unsure what a placeholder represents, check the context or ask the maintainer.
HTML and Unicode entities: Keep HTML entities (e.g.,  , <) exactly as they appear in the source, or replace them with their corresponding character if appropriate.
New lines: Ensure your translation has the exact same number of new lines (\n) as the English source text.

Pay Attention to Read-Only and Failing Checks

Some strings are marked as read-only or flagged to be ignored. Do not force translations on these. Weblate has built-in quality checks that will trigger a failing check warning if your translation mismatches the source format, variables, or punctuation. Always review and resolve these warnings.

Punctuation, Capitalization, Double Spaces, and Typos

Small details matter. An inconsistent interface reduces user trust. While translating and reviewing, ensure you:
Use correct and consistent punctuation.
Use correct capitalization. Match the English source unless your language rules dictate otherwise.
Add the correct number of brackets and parentheses.
Do not add double spaces unless present in the original source. Weblate will flag trailing or multiple spaces as a failing check.

Reference Other Languages

If you are multilingual, you can view current translations in other languages to better understand the context. Use the "Other languages" tab in the Weblate editor. Remember to ultimately defer to the English source text, as other translations may not be fully reviewed.

Always Keep the End User in Mind

Ask yourself if a non-technical user would understand your translation without help. The goal is to make the text understandable and culturally appropriate, rather than translating literally.

Know the Style Guide

Check to see if there is a style guide for your language on this wiki.
No style guide on the Localization Lab wiki for your language team? Refer to style guides for other technical projects.