Notas para traductores

Max PrilutskiyCEO y cofundadorActualizado el hace 3 meses · 2 min de lectura

Obsoleto

Esta documentación cubre el CLI heredado (v0). La versión actual del CLI es la v1. Ver la documentación actual de CLI

Algunos formatos de archivo admiten comentarios en línea que el CLI de Lingo.dev incluye en las solicitudes de traducción. Estos comentarios le dan contexto al modelo de IA: aclaran términos ambiguos, definen el tono o indican dónde aparece el contenido en la interfaz.

Por qué importan las notas para traductores#

La palabra "Records" puede referirse a expedientes médicos, discos de música o registros de base de datos. Sin contexto, el modelo de IA tiene que adivinar. Una nota para traductores elimina esa ambigüedad:

jsonc
{
  // Medical context: refers to patient medical records
  "records": "Records"
}

El comentario se envía junto con la cadena en la solicitud de traducción, guiando al modelo hacia la interpretación correcta.

Formatos compatibles#

Actualmente, las notas para traductores son compatibles con:

FormatoTipo de bucketSintaxis de comentarios
JSONCjsonc// comment sobre la clave
Catálogos de strings de Xcodexcode-xcstringsCampo de comentario en el archivo .xcstrings

Ejemplo de JSONC#

jsonc
{
  // Navigation menu item - appears in the top header bar
  "nav.home": "Home",

  // Button label - triggers form submission, keep it short
  "form.submit": "Submit",

  // "Light" refers to the visual theme, not weight or illumination
  "settings.theme.light": "Light"
}

Para usar JSONC, configura el tipo de bucket jsonc en tu i18n.json:

json
{
  "buckets": {
    "jsonc": {
      "include": ["locales/[locale].jsonc"]
    }
  }
}

Cómo escribir notas efectivas#

Las notas para traductores efectivas describen contexto que no se desprende de la cadena por sí sola:

EfectivaPor qué
// Button label in checkout flowLe indica al modelo dónde aparece en la interfaz y qué tan breve debe ser
// "Set" means a collection, not the verbAclara una palabra con varios significados
// Formal tone - displayed in legal footerDefine el registro esperado

Las notas que solo repiten la cadena (// This says Welcome) no aportan valor.

Siguientes pasos#