Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- CERN‐HSF
- Escritor técnico:
- LuckInTheRain
- Nombre del proyecto:
- Ampliar y mejorar la documentación 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 utiliza la comunidad de física de alta energía de todo el mundo.
Además de las habilidades técnicas de escritor que puedo aportar para el proyecto, también estoy familiarizado con el modelo ROOT (6 y 7) y conozco otros componentes que requiere el proyecto, como los siguientes:
- C++
- Python
- Git/GitHub
- Herramientas de construcción de sitios web (html, Markdown, Jekyll)
identifico tres partes principales en la documentación ROOT:
- el sitio web https://root.cern.
- la guía de referencia de la clase C++ https://root.cern/doc/master/.
- el foro https://root-forum.cern.ch
Parece que la documentación ROOT (el nuevo "manual ROOT") debe mejorarse y complementarse en las siguientes áreas:
- Debería ser más accesible y comprensible para los no físicos, en particular los capítulos introductorios.
- Se deben desarrollar más instructivos que expliquen la funcionalidad general de ROOT.
- Se incluirán algunos temas y desarrollos nuevos con descripciones y ejemplos detallados.
Las siguientes son algunas de ellas:
- La vinculación con Python
- Las bibliotecas matemáticas
- Descripción manual de 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 detalladas.
Las respuestas a preguntas importantes de los usuarios, como las publicadas en el foro ROOT, deberán incluirse 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 documentos en el nuevo “Manual ROOT” o en algunos instructivos nuevos de la Guía de referencia.
Instructivos que ilustran las funciones que ofrece ROOT 7
- Nuevos histogramas de ROOT 7
- Nuevos gráficos ROOT 7
Programa de tiempo estimado (5 meses):
- Fase 1: Definición de tareas y alcance para los instructivos y la documentación RAÍZ: 2 semanas
- Fase 2: Recopila y analiza preguntas importantes de los usuarios del foro ROOT: 2 semanas
- Fase 3: Escritura de la documentación ROOT: 8 semanas
- Fase 4: Desarrollo de instructivos: 8 semanas
Por último, debo agregar que ya contribuí a la documentación ROOT el año pasado con un proyecto de la temporada de Documentos de Google a largo plazo. Definí la nueva estructura del manual. La propuesta de este año contribuirá a que se completen otros aspectos de la documentación que aún faltan en ROOT.