🌐 Update translation prompts (fastapi#14619)

tiangolo · web-flow · commit d9b7b65b8139 · 2025-12-29T18:54:20.000Z
diff --git a/docs/de/llm-prompt.md b/docs/de/llm-prompt.md
diff --git a/docs/en/docs/_llm-test.md b/docs/en/docs/_llm-test.md
@@ -6,7 +6,7 @@ Tests added here will be seen by all designers of language specific prompts.
 
 Use as follows:
 
-* Have a language specific prompt – `docs/{language code}/llm-prompt.md`.
+* Have a language specific prompt - `docs/{language code}/llm-prompt.md`.
 * Do a fresh translation of this document into your desired target language (see e.g. the `translate-page` command of the `translate.py`). This will create the translation under `docs/{language code}/docs/_llm-test.md`.
 * Check if things are okay in the translation.
 * If necessary, improve your language specific prompt, the general prompt, or the English document.
diff --git a/docs/ja/llm-prompt.md b/docs/ja/llm-prompt.md
@@ -6,23 +6,23 @@ Language code: ja.
 
 ### Grammar and tone
 
-1) Use polite, instructional Japanese (です/ます調).
-2) Keep the tone concise and technical (match existing Japanese FastAPI docs).
+- Use polite, instructional Japanese (です/ます調).
+- Keep the tone concise and technical (match existing Japanese FastAPI docs).
 
 ### Headings
 
-1) Follow the existing Japanese style: short, descriptive headings (often noun phrases), e.g. 「チェック」.
-2) Do not add a trailing period at the end of headings.
+- Follow the existing Japanese style: short, descriptive headings (often noun phrases), e.g. 「チェック」.
+- Do not add a trailing period at the end of headings.
 
 ### Quotes
 
-1) Prefer Japanese corner brackets 「」 in normal prose when quoting a term.
-2) Do not change quotes inside inline code, code blocks, URLs, or file paths.
+- Prefer Japanese corner brackets 「」 in normal prose when quoting a term.
+- Do not change quotes inside inline code, code blocks, URLs, or file paths.
 
 ### Ellipsis
 
-1) Keep ellipsis style consistent with existing Japanese docs (commonly `...`).
-2) Never change `...` in code, URLs, or CLI examples.
+- Keep ellipsis style consistent with existing Japanese docs (commonly `...`).
+- Never change `...` in code, URLs, or CLI examples.
 
 ### Preferred translations / glossary
 
diff --git a/docs/ko/llm-prompt.md b/docs/ko/llm-prompt.md
@@ -6,23 +6,23 @@ Language code: ko.
 
 ### Grammar and tone
 
-1) Use polite, instructional Korean (e.g. 합니다/하세요 style).
-2) Keep the tone consistent with the existing Korean FastAPI docs.
+- Use polite, instructional Korean (e.g. 합니다/하세요 style).
+- Keep the tone consistent with the existing Korean FastAPI docs.
 
 ### Headings
 
-1) Follow existing Korean heading style (short, action-oriented headings like “확인하기”).
-2) Do not add trailing punctuation to headings.
+- Follow existing Korean heading style (short, action-oriented headings like “확인하기”).
+- Do not add trailing punctuation to headings.
 
 ### Quotes
 
-1) Keep quote style consistent with the existing Korean docs.
-2) Never change quotes inside inline code, code blocks, URLs, or file paths.
+- Keep quote style consistent with the existing Korean docs.
+- Never change quotes inside inline code, code blocks, URLs, or file paths.
 
 ### Ellipsis
 
-1) Keep ellipsis style consistent with existing Korean docs (often `...`).
-2) Never change `...` in code, URLs, or CLI examples.
+- Keep ellipsis style consistent with existing Korean docs (often `...`).
+- Never change `...` in code, URLs, or CLI examples.
 
 ### Preferred translations / glossary
 
diff --git a/docs/missing-translation.md b/docs/missing-translation.md
@@ -4,6 +4,6 @@ This page hasn’t been translated into your language yet. 🌍
 
 We’re currently switching to an automated translation system 🤖, which will help keep all translations complete and up to date.
 
-Learn more: [Contributing – Translations](https://fastapi.tiangolo.com/contributing/#translations){.internal-link target=_blank}
+Learn more: [Contributing - Translations](https://fastapi.tiangolo.com/contributing/#translations){.internal-link target=_blank}
 
 ///
diff --git a/docs/pt/llm-prompt.md b/docs/pt/llm-prompt.md
@@ -14,15 +14,15 @@ When translating documentation into Portuguese, use neutral and widely understan
 
 For the next terms, use the following translations:
 
-* «/// check»: «/// check | Verifique»
-* «/// danger»: «/// danger | Cuidado»
-* «/// info»: «/// info | Informação»
-* «/// note | Technical Details»: «/// note | Detalhes Técnicos»
-* «/// info | Very Technical Details»: «/// note | Detalhes Técnicos Avançados»
-* «/// note»: «/// note | Nota»
-* «/// tip»: «/// tip | Dica»
-* «/// warning»: «/// warning | Atenção»
-* «(you should)»: «(você deveria)»
+* /// check: /// check | Verifique
+* /// danger: /// danger | Cuidado
+* /// info: /// info | Informação
+* /// note | Technical Details: /// note | Detalhes Técnicos
+* /// info | Very Technical Details: /// note | Detalhes Técnicos Avançados
+* /// note: /// note | Nota
+* /// tip: /// tip | Dica
+* /// warning: /// warning | Atenção
+* (you should): (você deveria)
 * async context manager: gerenciador de contexto assíncrono
 * autocomplete: autocompletar
 * autocompletion: preenchimento automático
diff --git a/docs/tr/llm-prompt.md b/docs/tr/llm-prompt.md
@@ -6,22 +6,22 @@ Language code: tr.
 
 ### Grammar and tone
 
-1) Use instructional Turkish, consistent with existing Turkish docs.
-2) Use imperative/guide language when appropriate (e.g. “açalım”, “gidin”, “kopyalayalım”).
+- Use instructional Turkish, consistent with existing Turkish docs.
+- Use imperative/guide language when appropriate (e.g. “açalım”, “gidin”, “kopyalayalım”).
 
 ### Headings
 
-1) Follow existing Turkish heading style (Title Case where used; no trailing period).
+- Follow existing Turkish heading style (Title Case where used; no trailing period).
 
 ### Quotes
 
-1) Keep quote style consistent with the existing Turkish docs (they frequently use ASCII quotes in prose).
-2) Never change quotes inside inline code, code blocks, URLs, or file paths.
+- Alıntı stili mevcut Türkçe dokümanlarla tutarlı tutun (genellikle metin içinde ASCII tırnak işaretleri kullanılır).
+- Satır içi kod, kod blokları, URL'ler veya dosya yolları içindeki tırnak işaretlerini asla değiştirmeyin.
 
 ### Ellipsis
 
-1) Keep ellipsis style consistent with existing Turkish docs.
-2) Never change `...` in code, URLs, or CLI examples.
+- Üç nokta (...) stili mevcut Türkçe dokümanlarla tutarlı tutun.
+- Kod, URL veya CLI örneklerindeki `...` ifadesini asla değiştirmeyin.
 
 ### Preferred translations / glossary
 
@@ -39,8 +39,8 @@ Do not translate technical terms like path, route, request, response, query, bod
 
 ### `///` admonitions
 
-1) Keep the admonition keyword in English (do not translate `note`, `tip`, etc.).
-2) If a title is present, prefer these canonical titles:
+- Keep the admonition keyword in English (do not translate `note`, `tip`, etc.).
+- If a title is present, prefer these canonical titles:
 
 - `/// note | Not`
 - `/// note | Teknik Detaylar`
diff --git a/docs/uk/llm-prompt.md b/docs/uk/llm-prompt.md
@@ -6,23 +6,23 @@ Language code: uk.
 
 ### Grammar and tone
 
-1) Use polite/formal address consistent with existing Ukrainian docs (use “ви/ваш”).
-2) Keep the tone concise and technical.
+- Use polite/formal address consistent with existing Ukrainian docs (use “ви/ваш”).
+- Keep the tone concise and technical.
 
 ### Headings
 
-1) Follow existing Ukrainian heading style; keep headings short and instructional.
-2) Do not add trailing punctuation to headings.
+- Follow existing Ukrainian heading style; keep headings short and instructional.
+- Do not add trailing punctuation to headings.
 
 ### Quotes
 
-1) Prefer Ukrainian guillemets «…» for quoted terms in prose, matching existing Ukrainian docs.
-2) Never change quotes inside inline code, code blocks, URLs, or file paths.
+- Prefer Ukrainian guillemets «…» for quoted terms in prose, matching existing Ukrainian docs.
+- Never change quotes inside inline code, code blocks, URLs, or file paths.
 
 ### Ellipsis
 
-1) Keep ellipsis style consistent with existing Ukrainian docs.
-2) Never change `...` in code, URLs, or CLI examples.
+- Keep ellipsis style consistent with existing Ukrainian docs.
+- Never change `...` in code, URLs, or CLI examples.
 
 ### Preferred translations / glossary
 
@@ -35,8 +35,8 @@ Use the following preferred translations when they apply in documentation prose:
 
 ### `///` admonitions
 
-1) Keep the admonition keyword in English (do not translate `note`, `tip`, etc.).
-2) If a title is present, prefer these canonical titles (choose one canonical form where variants exist):
+- Keep the admonition keyword in English (do not translate `note`, `tip`, etc.).
+- If a title is present, prefer these canonical titles (choose one canonical form where variants exist):
 
 - `/// note | Примітка`
 - `/// note | Технічні деталі`
diff --git a/docs/zh-hant/llm-prompt.md b/docs/zh-hant/llm-prompt.md
@@ -6,30 +6,30 @@ Language code: zh-hant.
 
 ### Grammar and tone
 
-1) Use clear, concise technical Traditional Chinese consistent with existing docs.
-2) Address the reader naturally (commonly using “你/你的”).
+- Use clear, concise technical Traditional Chinese consistent with existing docs.
+- Address the reader naturally (commonly using “你/你的”).
 
 ### Headings
 
-1) Follow existing Traditional Chinese heading style (short and descriptive).
-2) Do not add trailing punctuation to headings.
+- Follow existing Traditional Chinese heading style (short and descriptive).
+- Do not add trailing punctuation to headings.
 
 ### Quotes and punctuation
 
-1) Keep punctuation style consistent with existing Traditional Chinese docs (they often mix English terms like “FastAPI” with Chinese text).
-2) Never change punctuation inside inline code, code blocks, URLs, or file paths.
-3) For more details, please follow the [Chinese Copywriting Guidelines](https://github.com/sparanoid/chinese-copywriting-guidelines).
+- Keep punctuation style consistent with existing Traditional Chinese docs (they often mix English terms like “FastAPI” with Chinese text).
+- Never change punctuation inside inline code, code blocks, URLs, or file paths.
+- For more details, please follow the [Chinese Copywriting Guidelines](https://github.com/sparanoid/chinese-copywriting-guidelines).
 
 ### Ellipsis
 
-1) Keep ellipsis style consistent within each document, prefer `...` over `……`.
-2) Never change ellipsis in code, URLs, or CLI examples.
+- Keep ellipsis style consistent within each document, prefer `...` over `……`.
+- Never change ellipsis in code, URLs, or CLI examples.
 
 ### Preferred translations / glossary
 
-1. Should avoid using simplified Chinese characters and terms. Always examine if the translation can be easily comprehended by the Traditional Chinese readers.
-2. For some Python-specific terms like "pickle", "list", "dict" etc, we don't have to translate them.
-3. Use the following preferred translations when they apply in documentation prose:
+- Should avoid using simplified Chinese characters and terms. Always examine if the translation can be easily comprehended by the Traditional Chinese readers.
+- For some Python-specific terms like "pickle", "list", "dict" etc, we don't have to translate them.
+- Use the following preferred translations when they apply in documentation prose:
 
 - request (HTTP): 請求
 - response (HTTP): 回應
@@ -50,5 +50,11 @@ Notes:
 
 - `details` blocks exist; keep `/// details` as-is and translate only the title after `|`.
 - Example canonical titles used in existing docs:
-  - `/// details | 上述指令的含義`
-  - `/// details | 關於 `requirements.txt``
+
+```
+/// details | 上述指令的含義
+```
+
+```
+/// details | 關於 `requirements.txt`
+```
diff --git a/docs/zh/llm-prompt.md b/docs/zh/llm-prompt.md
@@ -6,24 +6,24 @@ Language code: zh.
 
 ### Grammar and tone
 
-1) Use clear, concise technical Chinese consistent with existing docs.
-2) Address the reader naturally (commonly using “你/你的”).
+- Use clear, concise technical Chinese consistent with existing docs.
+- Address the reader naturally (commonly using “你/你的”).
 
 ### Headings
 
-1) Follow existing Simplified Chinese heading style (short and descriptive).
-2) Do not add trailing punctuation to headings.
-3) If a heading contains only the name of a FastAPI feature, do not translate it.
+- Follow existing Simplified Chinese heading style (short and descriptive).
+- Do not add trailing punctuation to headings.
+- If a heading contains only the name of a FastAPI feature, do not translate it.
 
 ### Quotes and punctuation
 
-1) Keep punctuation style consistent with existing Simplified Chinese docs (they often mix English terms like “FastAPI” with Chinese text).
-2) Never change punctuation inside inline code, code blocks, URLs, or file paths.
+- Keep punctuation style consistent with existing Simplified Chinese docs (they often mix English terms like “FastAPI” with Chinese text).
+- Never change punctuation inside inline code, code blocks, URLs, or file paths.
 
 ### Ellipsis
 
-1) Keep ellipsis style consistent within each document, prefer `...` over  `……`.
-2) Never change ellipsis in code, URLs, or CLI examples.
+- Keep ellipsis style consistent within each document, prefer `...` over  `……`.
+- Never change ellipsis in code, URLs, or CLI examples.
 
 ### Preferred translations / glossary
 
@@ -36,8 +36,8 @@ Use the following preferred translations when they apply in documentation prose:
 
 ### `///` admonitions
 
-1) Keep the admonition keyword in English (do not translate `note`, `tip`, etc.).
-2) If a title is present, prefer these canonical titles:
+- Keep the admonition keyword in English (do not translate `note`, `tip`, etc.).
+- If a title is present, prefer these canonical titles:
 
 - `/// tip | 提示`
 - `/// note | 注意`
diff --git a/scripts/general-llm-prompt.md b/scripts/general-llm-prompt.md
diff --git a/scripts/translate.py b/scripts/translate.py
