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:
- Juan
- Nombre del proyecto:
- CERN-HSF: Documentación ROOT para la adopción del público general, instructivos y vinculaciones dinámicas de Python
- Duración del proyecto:
- Larga duración (5 meses)
Project description
CERN-HSF - Documentación ROOT para la adopción del público general, Vinculaciones dinámicas de Python e Instructivos Mentor: Olivier Couet, Axel Naumann
Abstracto: La documentación es esencial para que los usuarios adopten el software de forma eficaz y exitosa. La documentación del usuario clara, precisa y completa facilita que los usuarios dominen el software a medida que se esfuerzan por alcanzar sus objetivos. En estas líneas, los instructivos y ejemplos explícitos sirven como herramientas poderosas que los usuarios pueden aprender rápidamente.
A medida que examinamos el uso de ROOT por parte de físicos, investigadores y desarrolladores dentro del espacio de análisis y visualización de datos para la física, se reconocen los beneficios de la documentación actualizada y fácil de usar. En particular, debido a la amplitud del código fuente y su crecimiento, el sistema de documentación se beneficia de la evolución paralela para otorgar a los usuarios la capacidad de maximizar todo lo que ofrece ROOT.
Resumen y análisis de la documentación actual Actualmente, la documentación del usuario ofrece una guía que permite a los físicos adoptar el RAÍZ con mayor facilidad en relación con un público general. Además, en ciertos temas como las vinculaciones dinámicas de Python, se podrían realizar mejoras para proporcionar documentación más completa y clara. Del mismo modo, al nuevo formato de datos RNTuple le faltan las especificaciones detalladas necesarias. Por último, a la documentación actual le faltan instructivos relacionados con ROOT 7.
Metodología: Después de conversar con Olivier, parecía que, para abordar los problemas antes mencionados, el enfoque principal debía identificar las brechas de conocimiento entre investigadores especializados y un público general, crear documentación para cerrarla, escribir una documentación más detallada de las vinculaciones dinámicas de Python, implementar “instructivos para el análisis moderno” de ROOT 7 y crear especificaciones técnicas detalladas para RNTuple. En esas líneas, durante este proceso, la documentación podría incorporar {i>notebooks<i} de Jupyter para que las herramientas de aprendizaje interactivas y tangibles puedan ayudar a los usuarios.
Cronograma: Se estima que las etapas del proyecto son: Identificar brechas de conocimiento entre investigadores especializados y un público general (mientras lees la documentación actual y el código fuente) → 1 a 2 semanas Crear y refactorizar documentación para cerrar esa brecha → 3 semanas Escribir una documentación más detallada de las vinculaciones dinámicas de Python → 3 semanas Implementar instructivos para las vinculaciones dinámicas de Python y un público general → 3 semanas Implementar instructivos para las especificaciones técnicas detalladas de ROOT → 3 semanas
Entregas y pautas para lograr el éxito: Documentación unificada para usuarios sin brechas Documentación del usuario actualizada por completo para reflejar las funciones más recientes, es decir, nuevas clases derivadas Instructivos a través de notebooks de Jupyter