Documentación de nuevas características y cambios

Con cada versión de Blender, se introducen fantásticas nuevas características, mejoras y cambios. Para asegurar que los usuarios de Blender puedan sacar el mayor provecho posible de esas actualizaciones, la documentación deberá ser paralelamente actualizada.

El proyecto de documentación de Blender rastrea los cambios que necesiten actualizaciones o adiciones en el manual. Al contribuir, podrás ayudar a mantener el manual preciso y valioso para la comunidad global de Blender.

Esta guía recorrerá el proceso de documentar estos cambios usando los incidentes de lanzamiento y los registros de cambios de cada nueva versión.

Uso de los incidentes de lanzamiento para rastrear cambios

Cada versión de Blender tiene un incidente asociado en el Proyecto de próximas versiones <https://projects.blender.org/blender/blender-manual/projects/28> del proyecto de documentación. Estos incidentes contendrán una lista curada de modificaciones del código fuente del proceso de desarrollo del Blender que presentarán los cambios que el usuario encontrará. Estos cambios normalmente implicarán una actualización en el manual, tales como nuevas secciones, modificaciones en instrucciones o actualización de capturas de pantalla.

Pasos para contribuir

1. Ubicar el incidente con la versión:

   • Navegar hasta la lista de incidentes en proyecto de documentación y abrir el incidente correspondiente a la versión actual/siguiente de Blender.

   • Revisar la lista en modificaciones proporcionada en la descripción del incidente. Cada modificación representará un cambio o una característica que necesitará ser documentada.

2. Escoger una modificación:

   • Seleccionar una modificación que sea de interés o se alinee con tu experiencia. Por ejemplo, si estuvieras familiarizado con las herramientas de modelado, escoger un cambio relacionado con ese tipo de características.

   • Asegurarse de que nadie más se encuentre trabajando en la misma tarea, comprobando los comentarios o las actualizaciones de estado del incidente.

3. Comprender el cambio:

   • Leer el mensaje de la modificación:

     Los mensajes de las modificaciones a menudo resumen el propósito y el alcance del cambio. Es posible que tengan un enlace hacia una petición de modificación (PR) o contengan enlaces a discusiones relacionadas.

   • Comprobar la solicitud o el código:

     El PR enlazado proporcionará contexto adicional, incluyendo descripciones, imágenes o videos explicativos de la característica. Revisar los cambios en el código también podrá ayudar a entender cómo es que funciona la nueva característica.

   • Comprobar la característica:

     Abrir Blender y probar la característica para verla en acción. La experiencia de primera mano clarificará el comportamiento de la característica y cómo es que los usuarios deberán interactuar con la misma.

4. Contactarse si es necesario:

   • En caso de que el mensaje de la modificación o el PR no proporcionaran suficiente información, será posible:

     • Contactar al desarrollador del cambio (su nombre de usuario normalmente estará en el PR).

     • Realizar consultas en los canales y foros de desarrollo de Blender.

Consideraciones clave para la documentación

Al documentar un cambio, tener presente lo siguiente:

• ¿Cuál es su propósito?:

  Comprender por qué fue realizado el cambio. ¿Mejora la usabilidad, introduce una nueva capacidad o corrige un problema?

• ¿Quién se beneficia?:

  Considerar a la audiencia objetivo de la característica. ¿Se encuentra pensada para animadores, modeladores u otro grupo de usuarios?

• ¿Cómo funciona?:

  Escribir instrucciones claras y concisas. Incluir ejemplos prácticos o casos de uso, cuando sea posible.

• Buscar dependencias:

  Algunos cambios podrían depender de otras características o afectar a otras funciones existentes. Comprobar si el cambio impactará en otras partes del manual.

• Capturas de pantalla y elementos visuales:

  En caso de que el cambio afectara a la interfaz de Blender, realizar nuevas capturas de pantalla para ilustrarlo. Asegurarse de que los elementos visuales reflejen la versión correcta de Blender.

Envío del trabajo

Una vez que se haya bocetado la documentación:

1. Escribir siguiendo el manual de estilo:

   Ceñirse a la guía de estilo de la documentación de Blender para asegurar claridad y consistencia.

2. Enviar la contribución:

   • Abrir una solicitud de modificación en el proyecto de documentación.

   • Hacer referencia a la incidencia de la versión y a la modificación, en la descripción de la solicitud.

   • Incluir cualquier captura de pantalla, diagrama o ejemplo que hubieran sido creados.

3. Colaborar:

   Trabajar con el equipo de revisión para refinar la nueva documentación producida, hasta que se encuentre lista para ser publicada.

Cada contribución es valiosa

Contribuir a la documentación de Blender es una forma reconfortante de apoyar a la comunidad y asegurarse de que los usuarios puedan entender las nuevas características. Mediante la documentación de esos cambios, podrás jugar un rol importante para ayudar a hacer que Blender sea más accesible y disfrutable para todo el mundo.

¡Comienza a explorar las nuevas características del próximo lanzamiento y ayuda a traer a la vida las innovaciones de Blender!