Resumen de la reunión de documentación

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

Datos de la reunión

Próxima reunión semanal

Presentación y explicación del proyecto

Una vez que el proyecto está alojado en GitHub, @estelaris comienza la reunión exponiendo como se ha construido. Paso a paso se van desgranando todas las funciones y como ha quedado finalmente el proyecto dentro de GitHub.

Estructura y desarrollo del proyecto [HelpHub]

Una vez que el proyecto está alojado en GitHub, @estelaris comienza la reunión exponiendo como se ha construido. Paso a paso se van desgranando todas las funciones y como ha quedado finalmente el proyecto dentro de GitHub.

Estructura y desarrollo del proyecto [HelpHub]

El proyecto queda definido con la etiqueta [HelpHub], dentro del Spain Handbook. Así se evitará que se pueda mezclar documentación con la existente y facilitará la gestión de los issues al estar identificados en su inicio con dicha etiqueta.

Quedan definitivamente pautados los pasos a seguir. En cuanto al proceso de la traducción propiamente. Se define que el mejor alojar la traducción en el apartado de comentarios que aparece en la parte inferior del issue traducido, al estilo de WordPress global, desestimando la opción de ir creando Google Docs.

También queda definido el proceso de este texto una vez entregado de la siguiente manera:

  • Pendiente: son los issues que están por asignar y aparecerán con el título en inglés, ya que están sin traducir.
  • En proceso: una vez asignado, aparecerá en esta sección el issue con la imagen de la persona que está contribuyendo en ese issue.
  • Revisión del equipo de documentación: se revisará el fondo del texto traducido, de forma que el original y la adaptación expresen lo mismo.
  • Revisión del equipo de traducción: se centrará en validar la forma y que los textos cumplen la guía de estilos y el glosario.
  • Acabado: en esta sección quedarán los textos finalizados y revisados que hayan pasado todos los filtros previos.

Imágen de como queda organizado el proyecto en GitHub

Si existen comentarios, o posibles modificaciones de los textos, se efectuarán en la sección que tiene GitHub al final de cada página, con el fin de evitar que se generen conversaciones o comentarios en Slack y se puedan perder con el paso del tiempo.

¿Qué vas a encontrar al abrir un issue?

Al abrir un issue encontrarás varios elementos que se definen de la siguiente manera.

  • Primero: la línea superior es el enlace a la categoría
  • Segundo: la segunda línea corresponde al enlace al título
  • Tercero: tras el encabezado llamado general, encontrarás las tareas a realizar.

Tareas que se realizan habitualmente dentro de un issue

  • Traducir el título
  • adaptar los textos del inglés al español.
  • Si el issue contiene imágenes o videos, se deben generar.
  • Crear el texto alternativo para las imágenes.

No siempre se encontrarán las mismas tareas a realizar. Dependerá en gran medida del issue que se haya solicitado. No obstante, como se puede apreciar en la imagen, encontrarás toda la información de las tareas a realizar una vez que se abra el issue.

Ejemplo de la información descrita en la anterior lista.

Afinado de la guía de estilos

@neusitas propone una aclaración sobre el estilo de voz y tono para poder seguir afinando la guía de estilos. Se ha acordado que realizarán por separado una reunión para hablar del tema entre @neusitas y el equipo de traducción. Posteriormente a esa reunión se generará un documento donde se podrá debatir si es correcto o se debe añadir, rectificar o suprimir parte de la propuesta. Cuando esa tarea esté realizada tras la reunión, @nilovelez compartirá el documento para su debate y aprobación.

@estelaris solicitará la URL //es.wordpress.org/documentacion/ que es donde se ubicarán todos los documentos traducidos y terminados. El sitio web permanecerá cerrado hasta que sea el momento de lanzamiento. Entretanto, algunos miembros del equipo tendrán acceso a este sitio web para su gestión y revisión. No queda determinado quienes serán esos miembros en esta reunión.

Props a @javiercasares y @glycymeris por la revisión de este texto.

#documentacion #reuniones #resumen

#github, #reunion