Translations
Las traducciones automatizadas están disponibles como un complemento de pago para los planes Growth, Pro y Enterprise. Por favor contacte con ventas para más información.
Visión general
Puede traducir automáticamente su documentación a varios idiomas mientras mantiene la estructura, el formato y los enlaces con IA. Las traducciones se integran con la función de languages, permitiendo a los lectores cambiar entre los idiomas disponibles en su documentación.
Requisitos previos
- Debe tener un plan Growth, Pro o Enterprise y complementos de traducción para sus idiomas de destino.
- Debe usar GitHub como proveedor de repositorio para el contenido de su documentación.
- Su documentación debe usar inglés como idioma base.
- Debe tener un archivo
docs.json
válido en su repositorio. - Todo el contenido a traducir debe usar un formato
MDX
válido. CualquierMDX
inválido causará que la traducción falle.
Primeros pasos
Comience con una traducción completa de su documentación a cada uno de sus idiomas preferidos. Este enfoque asegura una cobertura completa en cada idioma y actualiza automáticamente su archivo docs.json
.
Puede iniciar una traducción completa desde la página de traducciones en su dashboard.
- Seleccione Iniciar traducción.
- Seleccione el primer idioma al que desea traducir su contenido y luego seleccione Iniciar traducción.
- El proceso de traducción creará una nueva rama y una solicitud de extracción en el repositorio de su proyecto Mintlify con el contenido traducido. Los conjuntos de documentación más grandes pueden tardar más en procesarse.
- Revise la solicitud de extracción y fusionela.
- Repita el proceso para cada idioma al que desee traducir.
Una traducción automatizada se almacena en un directorio nombrado según el código de idioma que ha seleccionado.
Los nombres de directorio personalizados para las traducciones no son compatibles en este momento.
Traducciones continuas
Después de agregar una traducción a su archivo docs.json
, cualquier cambio futuro en su documentación se traduce automáticamente siempre que mantenga una suscripción al complemento de traducción para sus idiomas configurados.
El proceso de traducción continua sigue esta secuencia:
- Un miembro de su organización realiza cambios en la documentación en su repositorio.
- Cuando los cambios se envían o se fusionan en su rama principal, se activa el trabajo de traducción continua.
- El trabajo de traducción actualiza, elimina o crea los archivos necesarios en todos los idiomas suscritos según su archivo
docs.json
. - El trabajo de traducción crea una rama separada y una solicitud de extracción que contiene los cambios traducidos para su revisión.
Mintlify nunca publicará automáticamente las traducciones en producción. Debe revisar y fusionar cada solicitud de extracción de traducción antes de que los cambios estén en vivo.
El trabajo de traducción automática no maneja bien los cambios manuales en los archivos localizados o en los árboles de navegación docs.json
. Realice todos los cambios en su contenido en inglés y deje que el servicio de traducción gestione las versiones localizadas.
Recomendamos revisar y fusionar rápidamente las solicitudes de extracción de traducción para mantener sus localizaciones sincronizadas.
Escribir contenido para ser traducido
Para hacer que su documentación sea más traducible y más fácil de leer en inglés, evite estos patrones comunes:
- Verbosidad: Las oraciones redundantes son más difíciles de comprender y traducir.
- Evite: “Con el fin de poder completar con éxito el proceso de instalación…”
- Mejor: “Para instalar el software…”
- Voz pasiva: La voz pasiva hace que no esté claro quién realiza una acción.
- Evite: “El archivo de configuración debe ser actualizado por el administrador.”
- Mejor: “El administrador debe actualizar el archivo de configuración.”
- Oraciones negativas: Diga a las personas qué hacer en lugar de qué no hacer.
- Evite: “No olvide no saltarse el paso de configuración.”
- Mejor: “Recuerde completar el paso de configuración.”
- Pronombres: Palabras como “ello”, “esto” y “eso” pueden no ser claras sobre a qué se refieren, especialmente si una oración usa muchos pronombres. Use sustantivos específicos en su lugar.
- Evite: “Configure la conexión de la base de datos. Después de hacer esto, funcionará correctamente.”
- Mejor: “Configure la conexión de la base de datos. Después de configurar la conexión, la base de datos funcionará correctamente.”
- Evite: “Cuando lo configure, asegúrese de que se conecte a ellos correctamente para que puedan comunicarse entre sí.”
- Mejor: “Cuando configure la base de datos, asegúrese de que la base de datos se conecte a los servidores correctamente para que los servidores puedan comunicarse entre sí.”
- Anclas de enlace ambiguas: Describa con precisión a dónde va un enlace y evite anclas de enlace ambiguas como
Click here
. Cuando sea posible, use el título exacto de la página o recurso al que apunta un enlace.- Evite: “Haga clic
[here](path/to/getting-started-guide)
para aprender más sobre el proceso de configuración.” - Mejor: “Aprenda más sobre el proceso de configuración en nuestra
[getting started guide](path/to/getting-started-guide)
.”
- Evite: “Haga clic
- Nominalizaciones: Verbos o adjetivos convertidos en sustantivos, a menudo terminando en -ión, -miento o -dad. Use verbos activos en su lugar.
- Evite: “La configuración de su navegación requiere un
docs.json
válido.” - Mejor: “Debe tener un
docs.json
válido para configurar su navegación.”
- Evite: “La configuración de su navegación requiere un
- Modificadores apilados: Múltiples sustantivos o adjetivos agrupados crean ambigüedad sobre las relaciones entre las palabras.
- Evite: “Sistema de gestión de configuración de punto final de API.”
- Mejor: “Sistema para gestionar la configuración de puntos finales de API.”
- Frases preposicionales: Largas cadenas de frases preposicionales (frases que comienzan con palabras como “de”, “en”, “con”, “sobre”) crean oraciones complejas.
- Evite: “Las selecciones de las configuraciones en el panel de administración de la aplicación.”
- Mejor: “Configuración de la aplicación en el panel de administración.”
- Verbos auxiliares modales: Palabras como “podría”, “debería”, “sería” y “haría” que expresan posibilidad u obligación pueden ser poco claras. Utiliza comandos directos en su lugar.
- Evitar: “Podrías considerar actualizar la configuración, lo que potencialmente podría mejorar el rendimiento.”
- Mejor: “Actualiza la configuración para mejorar el rendimiento.”
- Modo no indicativo: Utiliza declaraciones directas en lugar del modo subjuntivo o condicional.
- Evitar: “Si configuraras los ajustes, la aplicación funcionaría correctamente.”
- Mejor: “Configura los ajustes para que la aplicación funcione correctamente.”
- Plurales invisibles: Deja claro si te refieres a elementos en singular o plural.
- Evitar: “Datos de usuario” (Podría ser datos de un usuario o de múltiples usuarios)
- Mejor: “Datos de usuarios individuales” o “Datos de todos los usuarios”
- Palabras específicas de género: Algunos idiomas tienen reglas de género que no se traducen directamente.
- Evitar: “Cuando un usuario inicia sesión, él debería ver su panel de control.”
- Mejor: “Después de iniciar sesión, los usuarios ven el panel de control.”
- Acrónimos: Define cualquier acrónimo en su primer uso para proporcionar contexto.
- Evitar: “Usa las operaciones CRUD.”
- Mejor: “Usa las operaciones CRUD (Crear, Leer, Actualizar, Eliminar).”
- Jerga, bromas o ejemplos culturalmente específicos: Usa un lenguaje que se traduzca bien.
- Evitar: “No te preocupes, te cubrimos las espaldas.”
- Mejor: “Proporcionamos soporte para este proceso.”
- Evitar: “Esta función la saca del estadio.”
- Mejor: “Esta función proporciona excelentes resultados.”