Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Servicios de edición de GStreamer
- Escritor técnico:
- Sidhartha10
- Nombre del proyecto:
- Actualización de la documentación de la biblioteca de GES
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Me gustaría participar en el programa Season of Docs y trabajar como escritor técnico en la organización GStreamer Editing Services (GES). Revisé los proyectos sugeridos por el equipo de GES y creo que puedo mejorar la documentación. Según mi conversación con Alexandru Balut de GES, me gustaría actualizar la documentación a continuación (en orden de prioridad descendente):
- Actualizaré esta página para actualizar la descripción general de la biblioteca de GES. Esta página se actualizará para incluir una jerarquía de todas las clases, como se menciona en esta página. Esta página contendrá información sobre todas las tareas o funcionalidades que se pueden lograr implementando la biblioteca GES. Por ejemplo, la administración de recursos y proxies en un proyecto de GES, líneas de tiempo, capas, clips y efectos. Esta página tendrá ejemplos que pueden ayudar a un usuario final a comprender mejor la funcionalidad. Por ejemplo, ¿cómo se puede aplicar un efecto en un clip para que se rote 0 grados al principio y 180 grados al final? Esta página se actualizará para incluir referencias cruzadas a todas las páginas secundarias.
- Para una clase individual, crearé diagramas de UML para mostrar la relación entre esa clase y las clases relacionadas.
- Mencionaré las diversas operaciones síncronas y asíncronas que envían códigos de error. Las operaciones síncronas envían códigos de retorno, como los booleanos (verdadero=correcto, falso=error), mientras que las operaciones asíncronas no envían ningún código de retorno. Como cualquier usuario nuevo de esta biblioteca encontrará códigos de error, es importante que estos se documenten de forma detallada.
- En la documentación actual, hay varias instancias en las que falta información sobre los miembros, los campos y los parámetros. Las constantes, las clases y los parámetros de los métodos virtuales (así como el método virtual en sí) no tienen descripción. De forma ad hoc, identificaré todas las brechas que faltan en la API y las corregiré. Esta será una tarea continua durante el transcurso del proyecto.