Resumen de la reunión de documentación

Notas de la reunión del equipo de documentación celebrada el día 2024-16-04

Datos de la reunión

Próxima reunión semanal

Revisión y estado de la guía de estilo para la traducción de la documentación

Tercera reunión del grupo de documentación. Se han tratado los siguientes temas:

Como punto inicial se han repasado los puntos que deben incluirse en el apartado de accesibilidad del cual se hace responsable @visanju.

Presentación a debate del proyecto realizado en la WordCamp Barcelona 2023

Durante el Contributor Day de la WordCamp Barcelona 2023, se reunieron en un equipo de trabajo varios miembros de los grupos de trabajo de: marketing, documentación y traducción. De esa conjunción de equipos surgió el boceto de un esquema traducido al español de España de las categorías y subcategorías. Durante los próximos días Estela convertirá este proyecto en una hoja editable, Excel o similar, en la que el grupo de documentación y todo el que quiera participar afinará las traducciones para que sean óptimas.

Datos de la documentación a traducir

En el equipo de documentación se ha realizado un esfuerzo para depurar la documentación de forma que sea lo más amigable posible, ya que está dirigida al usuario final. Esta información la ha proporcionado @estelaris.

Eso no impide a petición del equipo de soporte y dentro del grupo de trabajo hace referencia a ello también @nilovelez de la necesidad de incluir el apartado de instalación de WordPress en 5 minutos o instalación básica de WordPress. Se ha aprobado incluir ese apartado dentro de la documentación, ya que resulta un texto básico dentro de la documentación de WordPress, aunque sea para usuarios finales.

Ubicación y estructura de los textos creados En un principio

Las categorías se reparten en 4 grupos con sus sub etiquetas de la siguiente manera:

  • Grupo 1: Descripción general
  • Grupo 2: Guías técnicas
  • Grupo 3: Guías de soporte
  • Grupo 4: Personalización

En un inicio se dejará de forma provisional el nombre de «HelpHub» a todo el proyecto, aunque la idea es cambiar este nombre por uno que siga la guía de estilos del español de España y mantenga sentido con su nombre en inglés.

Los textos se ubicarán en el Spain Handbook, se crearán 4 proyectos, que son los grupos de categorías existentes y que de los cuales se dará prioridad al grupo 1 y 2 para comenzar a traducir, dejando el número 3 y 4 para más adelante, puesto que van a sufrir importantes transformaciones los textos y se opta por esperar esas acciones para traducir los nuevos textos que se creen.

La estructura de la documentación dentro del proyecto seguirá estos pasos:

  • No status: como listado general de issues.
  • In progress: issues en el que se está trabajando.
  • In review: traducción:  el encargado de realizar las revisiones de cumplimiento de la guía de estilo y glosario del español de España.
  • Done:
  • los documentos en esta columna han sido aprobados y están listos para subirse a es.worpress.org (aún no está confirmada la sección de documentación)

Asimismo, se añadirán las etiquetas que en cada caso sean pertinentes para que resulte más fácil el manejo de toda la documentación a lo largo de todo el proceso.

@josepmoran propone que se trabaje en local creando un fork del proyecto de documentación con la finalidad de evitar que se puedan crear problemas en el proyecto principal. Optando así por el sistema que se está utilizando en el Spain Handbook.

Contributor Day de Yoast

@estelaris nos recuerda que el próximo día 18 de abril se celebra este evento e invita a todos los presentes y los que puedan leer este resumen a participar de manera online a cualquiera que pueda participar.

WordCamp for Docs

@estelaris explica que la WordCamp for Docs estará enfocada en documentación. Pese a estar invitados todos los que quieran asistir, aún no se puede dar por hecho el día de celebración, que puede ser el día 18 de octubre del 2024.

Props a @estelaris por la revisión de este texto.

#documentacion #reuniones #agenda

Resumen de la reunión de documentación

Reunión celebrada el día 2024-04-12 en el Google Meet anunciado en la agenda de WordPress de España

Datos de la reunión

Próxima reunión semanal

Revisión y estado de la guía de estilo para la traducción de la documentación

Segunda reunión del grupo de documentación. Se han tratado los siguientes temas:

Agradecimiento a @neusitas, por los múltiples y valiosos recursos que ha aportado al borrador de la guía de estilos.

Debate y progresos sobre la guía de estilo para la traducción de la documentación

Durante la semana se han realizado avances en el borrador de la guía de estilos para traducción, si bien todo lo añadido no se va a aprovechar. Los motivos principales se han debatido de forma pública en el espacio de documentación en el Slack de España y durante la reunión del día de hoy.

Progresos de la semana

Se acuerda que el borrador final no debe ser de un volumen elevado de documentación, más al contrario. Debemos aplicar la guía de estilo del español de España, su glosario y como guía gramatical la RAE, incluyendo las excepciones que en ella no estén incluidas porque, en su mayoría, serán de carácter técnico.

Dentro de la sección de lenguaje y gramática se incluirá un enlace al glosario. Y cuando salgan palabras que aún no están en el mismo, se hará la recomendación al equipo de traducción para discusión.

@nilovelez propone comenzar a traducir cuanto antes para que los documentos generados puedan ser revisados por los GTE locales y poder detectar y afinar la guía de estilos.

Se ha establecido la base de la creación de un artículo accesible estructurado de la siguiente manera:

  • El propio título del artículo ejercerá las funciones de H1
  • Se seguirá una jerarquía lógica y dentro de los parámetros de accesibilidad. Por tanto, el primer encabezado será siempre un H2, los posteriores en orden correlativo; H3, H4, etc.
  • Si se realizan enlaces se ubicarán siempre en un lugar determinado del artículo, facilitando así el acceso a estos.
  • Los enlaces tienden a perderse, por lo que @nilovelez de forma acertada propone incluir la posible respuesta que ofrece el enlace en cuestión. De esa manera, en caso de perderse el enlace, siempre estará documentada la respuesta del mismo. Esto es aplicable solo para enlaces o fuentes externas.

Documentar de manera inclusiva

Se intentará en la medida de lo posible reducir la utilización de artículos de género, siempre y cuando no produzca errores gramaticales o que por ello derive en un texto sin sentido dentro de la lengua española.

En este apartado, @visanju será el encargado de revisar y ajustar la guía de accesibilidad de inglés a español.

El afinado del borrador de la guía de estilos en forma de Google Docs durará una semana más, tras lo cual se debatirá que partes de la documentación global se deben traducir en primer lugar.

Cambio de día y hora de la reunión del grupo de trabajo de documentación

Por votación de todos los presentes y el voto delegado de @visanju a @josepmoran se acuerda por mayoría cambiar la reunión del equipo de documentación con carácter inmediato al martes a las 17:30 pm, dando lugar a que la próxima reunión se celebrará el próximo martes día 16 de abril del 2024.

Props a @estelaris por la revisión de este texto.

#documentacion #reuniones #agenda

Resumen de la reunión sobre documentación

Reunión celebrada el día 2024-5-04 en el canal #documentación de WordPress de España

Datos de la reunión

Puedes leer la transcripción de la reunión a través de Slack.

Próxima reunión semanal

Control del proyecto

Primera reunión del grupo de documentación. Se han tratado los siguientes temas:

Agradecimiento a @luisrull, quien nos ha hecho saber que teníamos apuntado el enlace a la guía de traductores de forma errónea, lo cual es de agradecer por su parte.

Revisión y resolución de dudas sobre la guía de estilo para la traducción de la documentación

@neusitas aporta concreción sobre los siguientes temas:

  • Acrónimos
  • Siglas
  • Contracciones
  • Ejemplos en español en varios párrafos

Acrónimos: Se acuerda que los acrónimos son un subgénero de las siglas y no deben separarse como en inglés.

En este sentido, @glycymeris sugiere y se acepta la sugerencia de intentar aprovechar el rico léxico del idioma español para evitar inventar palabras.

@estelaris aporta un párrafo de ejemplo de las costumbres en inglés de realizar abreviaturas, aparte de este ejemplo, se añade la abreviatura en español «pq» (porque), como ejemplo de abreviatura en español que debe evitarse al realizar la adaptación de los textos escritos en inglés.

Se acuerda por consenso que no se realizarán traducciones literales, más bien se deben realizar adaptaciones al español de España de los textos escritos en inglés, otorgando cierta libertad para interpretar dichos textos.

También queda fijada la RAE como base para cualquier regla gramatical y, en la medida de lo posible, agregar el enlace correspondiente y la referencia para darle más autoridad al texto traducido.

El borrador de la guía de estilos en forma de Google Docs. Será la herramienta donde se realizarán las propuestas, comentarios y las posibles respuestas o debates que generen las mismas, dejando para la reunión semanal las posibles tomas de decisiones sobre lo publicado previamente en el borrador de la guía de estilos.

@neusitas revisará y afinará su sección sobre la base de los comentarios mencionados anteriormente, en caso de que aún queden dudas se solventarán en la siguiente reunión.

@visanju abre debate sobre el uso de las preposiciones cruzadas. @javiguembe aporta la sección de la RAE. Finalmente, @estelaris ha optado por eliminar la sección de preposiciones y realizar una explicación simple sobre el uso de las preposiciones.

@glycymeris anuncia la creación de una reunión semanal sobre la documentación del Spain-Handbook, de momento, sin fecha ni hora establecida.

Existen por parte de los asistentes ciertas reticencias sobre el día y hora acordados durante el Contributor Day de Torrelodones. Aunque se mantiene para la próxima semana el mismo día y hora, queda como uno de los puntos debatir en la próxima reunión un posible cambio de día y hora que tenga un consenso más amplio por los asistentes a la misma.

Props a @estelaris por la revisión de este texto.

#documentacion #reuniones #agenda