Skip to content

Traducir y mantener documentación y changelog en español #4

Description

@jsgrrchg

Propuesta

Propongo que la documentación del proyecto y el changelog se mantengan principalmente en español.

Piola es un lenguaje con identidad chilena, pensado también como una herramienta de aprendizaje para entender cómo funcionan los lenguajes de programación por dentro. Por lo mismo, sería coherente que la documentación, ejemplos, guías y notas de cambios estén disponibles en español de forma clara y consistente.

Motivación

Muchos estudiantes y personas que están aprendiendo programación en Chile no necesariamente se sienten cómodos leyendo documentación técnica en inglés. Si el objetivo del proyecto es ser cercano, educativo y chileno, tener la documentación en español ayuda a reducir esa barrera de entrada.

Esto permitiría que más personas puedan:

  • Entender cómo instalar y usar el lenguaje.
  • Leer ejemplos sin depender del inglés técnico.
  • Seguir el roadmap del proyecto.
  • Revisar cambios importantes entre versiones.
  • Contribuir con menos fricción.
  • Aprender conceptos como lexer, parser, AST, intérprete, VM o garbage collector desde una explicación más accesible.

Alcance sugerido

La idea sería revisar y mantener en español, al menos:

  • README.md
  • documentación dentro de docs/
  • guías de instalación y uso
  • ejemplos de código
  • mensajes explicativos para contribuir
  • release notes
  • CHANGELOG.md, si existe o si se agrega más adelante

Sobre el changelog

Sería útil que cada versión tenga un changelog en español, con una estructura simple como:

  • Cambios agregados
  • Cambios corregidos
  • Cambios internos
  • Cambios importantes para usuarios
  • Posibles breaking changes

Esto haría más fácil seguir la evolución del lenguaje sin tener que revisar directamente commits o pull requests.

Consideraciones

No propongo reescribir el historial antiguo de commits ni forzar que todo el desarrollo interno sea en español. La idea principal es que la documentación orientada a usuarios, estudiantes y potenciales contribuyentes esté en español. Considerar a futuro que los commits y PR estén todos redactados en español.

También podría mantenerse una versión secundaria en inglés más adelante, pero el español debería ser la versión principal por la identidad del proyecto.

Beneficios

  • Refuerza la identidad chilena del lenguaje.
  • Hace el proyecto más accesible para estudiantes.
  • Facilita la contribución de personas hispanohablantes.
  • Evita que el lenguaje tenga una personalidad chilena en la sintaxis, pero una documentación desconectada de esa identidad.
  • Ayuda a que Piola sea más fácil de enseñar, compartir y usar como proyecto educativo.

Propuesta concreta

Definir que la documentación oficial y el changelog del proyecto se escriban y mantengan en español, priorizando claridad, cercanía y consistencia con el tono chileno del lenguaje.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions