Skip to content

Guía de estilo

Rainer Martínez Fraga edited this page May 3, 2023 · 6 revisions

Traducción de los títulos

Cuando traduzcas los títulos, recuerda que solo debe empezar con mayúscula la primera palabra de la frase.

Ejemplo:

## Importing and Exporting Components

✅ CORRECTO:

## Importar y exportar componentes

❌ INCORRECTO:

## Importar y Exportar Componentes

No se debe traducir de golpe la navegación de la UI, no obstante si el título de la página que estás traduciendo también se encuentra en la barra lateral, se debería actualizar el archivo src/sidebar*.json correspondiente para reflejar el nuevo título.

Identificadores de los títulos

Los títulos de las secciones tienen identificadores explícitos de la siguiente manera:

## Try React {#try-react}

¡NO traduzcas estos identificadores! Se usan para la navegación y no funcionaría correctamente si se hace referencia externamente, o sea:

Consulta la [sección de inicio](/getting-started#try-react) para más información.

✅ CORRECTO:

## Prueba React {#try-react}

❌ INCORRECTO:

## Prueba React {#prueba-react}

Esto hará que el enlace de arriba deje de funcionar.

Texto en bloques de código

Deja el texto en los bloques de código sin traducir, excepto para los comentarios. Opcionalmente puedes traducir el texto en cadenas, ¡pero cuida de no traducir cadenas que hagan referencia a código!

Ejemplo:

// Example
const element = <h1>Hello, world</h1>;
ReactDOM.render(element, document.getElementById('root'));

✅ CORRECTO:

// Ejemplo
const element = <h1>Hello, world</h1>;
ReactDOM.render(element, document.getElementById('root'));

✅ TAMBIÉN CORRECTO:

// Ejemplo
const element = <h1>Hola mundo</h1>;
ReactDOM.render(element, document.getElementById('root'));

❌ INCORRECTO:

// Ejemplo
const element = <h1>Hola mundo</h1>;
// "root" hace referencia a un identificador de un elemento.
// NO LO TRADUZCAS
ReactDOM.render(element, document.getElementById('raíz'));

❌ DEFINITIVAMENTE INCORRECTO:

// Ejemplo
const elemento = <h1>Hola mundo</h1>;
ReactDOM.hacer(elemento, documento.obtenerElementoPorId('raíz'));

Enlaces externos

Si un enlace externo es a un artículo en un sitio de referencias como MDN o Wikipedia y existe una versión de este artículo en español con una calidad aceptable, considera sustituir el enlace por el de esa versión.

Ejemplo:

React elements are [immutable](https://en.wikipedia.org/wiki/Immutable_object).

✅ BIEN:

Los elementos de React son [inmutables](https://es.wikipedia.org/wiki/Objeto_inmutable).

Para enlaces que no tienen un equivalente en español (Stack Overflow, videos de YouTube, etcétera) mantén el enlace en inglés.

Usted, tú y vos

El uso de la segunda persona del singular varía en las diferentes variantes del español. Aunque todas son perfectamente válidas hemos optado por usar solo la forma «tú» para mantener la consistencia. Entre las razones para esta decisión se encuentra nuestro deseo de mantener el tono relativamente informal de la documentación original y evitar ambigüedades cuando se omite el pronombre.

El gerundio

El gerundio al inicio de los títulos es común en inglés. En la mayoría de los casos el calco debería evitarse y usar en su lugar formas más comunes en español como un sustantivo o el infinitivo:

Ejemplos:

## Thinking in React

✅ CORRECTO: Pensar en React

❌ DESACONSEJADO: Pensando en React

## Rendering Lists

✅ CORRECTO: Renderizado de listas

❌ DESACONSEJADO: Renderizando listas

Voz pasiva

En la documentación original en inglés se recurre frecuentemente a la voz pasiva. En la traducción también puede usarse una construcción pasiva o la voz activa. La elección dependerá el contexto y la naturalidad de la traducción final. Es por ello que debe evitarse solo utilizar la pasiva analítica producto del calco al original. Por ejemplo: "The file was generated" podría traducirse como "el archivo fue generado" (pasiva analítica), pero también "se generó el archivo" (pasiva refleja).

Comillas

Utiliza comillas rectas (dobles " y simples ') y el proceso de compilación se encargará de convertirlas en las comillas tipográficas apropiadas («», ‘’).

Tono

El estilo entre las páginas de la documentación puede variar y la traducción debe respetar el tono original.

Frases idiomáticas

En el original pueden aparecer el uso de expresiones idiomáticas de difícil traducción. Como primer paso dirígete al glosario para ver si ya hay alguna traducción de referencia. Si no es el caso es necesario ver el tono y la intención de la frase en el contexto original para poder realizar una reescritura con frases que resulten naturales en español. Se debe tener en cuenta que si se opta por un modismo en español debe estar los suficientemente extendido para que sea entendible sin importar la variante dialectal.

Mayúsculas en terminología de React

En algunos casos el equipo de React ha elegido diferenciar conceptos específicos de React del significado usual de la palabra mediante el uso de mayúscula: “Hook”, “Effect”, etc. En las traducciones se respetará este uso de las mayúsculas: «Hook», «Efecto», etc.