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:
- CERN-HSF
- Escritor técnico:
- LuckInTheRain
- Nombre del proyecto:
- Se extendió y mejoró la documentación de ROOT
- Duración del proyecto:
- Larga duración (5 meses)
Project description
El objetivo del proyecto es mejorar la documentación de ROOT, que es el principal sistema de software para el análisis y la presentación de datos que usa la comunidad de física de alta energía en todo el mundo.
Además de las habilidades de escritor técnico que puedo proporcionar para el proyecto, también conozco ROOT (6 y 7) y tengo conocimiento de otros componentes que requiere el proyecto, como los siguientes:
- C++
- Python
- Git/GitHub
- Herramientas de construcción de sitios web (HTML, Markdown y Jekyll)
Identifico tres elementos principales en la documentación de ROOT:
- el sitio web https://root.cern
- la guía de referencia de clases de C++ https://root.cern/doc/master/
- el foro https://root-forum.cern.ch
Me parece que la documentación de ROOT (el nuevo "manual de ROOT") debe mejorarse y complementarse en las siguientes áreas:
- Debería ser más accesible y comprensible para quienes no sean físicos, en particular los capítulos introductorios.
- Se desarrollarán más instructivos que expliquen la funcionalidad general de ROOT.
- Se deben incluir algunos temas y desarrollos nuevos con descripciones y ejemplos detallados.
Entre ellos, puedo mencionar los siguientes:
- La vinculación de Python
- Las bibliotecas matemáticas
- Descripción manual de las herramientas de gráficos de alto nivel (TRatioPLot, THStack)
- Las nuevas herramientas de análisis de minería de datos (RDataFrame y RNtuple)
- Los nuevos formatos de datos clave (RDataFrame y RNtuple) necesitan instructivos y especificaciones técnicas detallados.
Las respuestas a las preguntas importantes de los usuarios, como las que se publican en el foro de ROOT, se deben incluir en la documentación. Esto requiere un análisis detallado de las preguntas más frecuentes, seguido de un período de síntesis para traducirlas en documentación en el nuevo “Manual de ROOT” o en algunos instructivos nuevos de la Guía de referencia.
Instructivos que ilustran las funciones que proporciona ROOT 7.
- Nuevos histogramas de ROOT 7
- Nuevos gráficos de ROOT 7
Cronograma estimado (5 meses):
- Fase 1: Definición de tareas y alcance para la documentación y los instructivos de ROOT: 2 semanas.
- Fase 2: Recopilar y analizar las preguntas importantes de los usuarios del foro de ROOT: 2 semanas
- Fase 3: Escritura de documentación de ROOT: 8 semanas
- Fase 4: Desarrollo de instructivos: 8 semanas
Por último, debo agregar que ya contribuí a la documentación de ROOT el año pasado con un proyecto a largo plazo de la Temporada de Documentos de Google. Definimos la nueva estructura del manual. La propuesta de este año contribuirá a completar otros aspectos de la documentación que aún faltan en ROOT.