Receta: Traducir un README

Esta receta le guía para traducir un README en Markdown a otro idioma, manteniendo todos los elementos estructurales intactos.

Enfoque básico

yaku --to es -f README.md -o README.es.md

yaku detecta la extensión .md y aplica traducción con reconocimiento de Markdown: encabezados, bloques de código, enlaces, imágenes y front matter permanecen intactos. Solo la prosa se traduce.

Guía paso a paso

1. Configure un glosario (opcional pero recomendado)

Cree .yaku-glossary.yaml en la raíz de su proyecto para fijar términos clave:

es:
  MyProject: ~           # mantener nombre del proyecto
  GitHub: ~
  npm: ~
  MIT License: Licencia MIT

2. Traduzca

yaku --to es -f README.md -o README.es.md

3. Revise la salida

Verifique algunos puntos:

• ¿Los encabezados están en el nivel correcto?
• ¿Los bloques de código están sin cambios?
• ¿Las URLs de enlaces y rutas de imágenes están intactas?
• ¿La terminología del glosario se ve correcta?

4. Traduzca a idiomas adicionales

yaku --to fr -f README.md -o README.fr.md
yaku --to pt -f README.md -o README.pt.md

Agregar contexto para mejor calidad

Si su README cubre un dominio específico, agregue contexto:

yaku --to es \
  --context "documentación de herramienta CLI para desarrolladores" \
  -f README.md -o README.es.md

Automatizar con un script

Traduzca su README a múltiples idiomas:

#!/bin/bash
LANGUAGES=("es" "fr" "pt" "ja" "ko")

for lang in "${LANGUAGES[@]}"; do
  yaku --to "$lang" -f README.md -o "README.${lang}.md"
  echo "Traducido a $lang"
done

Consejos

• Siempre revise la salida. La traducción por LLM es buena pero no perfecta. Revise nombres de marca, términos técnicos y expresiones idiomáticas.
• Use un glosario para consistencia. Si retraduce después de actualizar el README, un glosario asegura que se usen los mismos términos cada vez.
• Traduzca desde el archivo fuente. Siempre traduzca desde el README en inglés (o idioma original), no desde otra versión traducida — esto evita la acumulación de errores.