Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- CERN-HSF
- Rédacteur technique:
- John
- Nom du projet:
- CERN-HSF : Documentation ROOT sur l'adoption du grand public, les liaisons Python dynamiques et les tutoriels
- Durée du projet:
- Longue durée (cinq mois)
Project description
CERN-HSF - ROOT Documentation for General Audience Adoption, Dynamic Python Bindings, and Tutorials Mentor: Olivier Couet, Axel Naumann
Résumé : La documentation est essentielle pour une adoption réussie et efficace des logiciels par les utilisateurs. Une documentation utilisateur claire, précise et complète aide les utilisateurs à maîtriser le logiciel afin d'atteindre leurs objectifs. À ce titre, des exemples explicites et des tutoriels constituent des outils puissants qui permettent aux utilisateurs d'apprendre rapidement.
Lorsque nous examinons l'utilisation de ROOT par les physiciens, les chercheurs et les développeurs dans le domaine de l'analyse et de la visualisation des données pour la physique, nous constatons que les avantages d'une documentation conviviale et à jour sont reconnus. En particulier, en raison de l'étendue du code source et de son évolution, le système de documentation peut bénéficier d'une évolution parallèle afin de permettre aux utilisateurs de maximiser tout ce que ROOT a à offrir.
Résumé et analyse de la documentation actuelle Actuellement, la documentation utilisateur propose un guide qui permet aux physiciens d'adopter ROOT plus facilement par rapport à un public général. De plus, dans certains sujets tels que les liaisons Python dynamiques, il est possible d'apporter des améliorations pour une documentation plus complète et plus claire. De même, le nouveau format de données RNTuple ne dispose pas des spécifications détaillées nécessaires. Enfin, la documentation actuelle ne contient pas de tutoriels sur ROOT 7.
Méthodologie : Après avoir discuté avec Olivier, il s'est avéré que, pour résoudre les problèmes mentionnés ci-dessus, la priorité devrait être d'identifier les lacunes entre les chercheurs spécialisés et le grand public, de créer de la documentation pour combler ce fossé, de rédiger une documentation plus détaillée sur les liaisons Python dynamiques, de mettre en œuvre des "tutoriels pour l'analyse moderne" pour ROOT 7 et de créer des spécifications techniques détaillées pour RNTuple. Au cours de ce processus, la documentation pourrait intégrer des notebooks Jupyter afin que des outils d'apprentissage tangibles et interactifs puissent aider les utilisateurs.
Calendrier : Les phases estimées du projet sont les suivantes : Identifiez les lacunes entre les chercheurs spécialisés et le grand public (tout en parcourant la documentation et le code source actuels) → 1 à 2 semaines Créez et refactorisez la documentation pour combler ce fossé → 3 semaines Rédigez une documentation plus détaillée sur les liaisons Python dynamiques → 3 semaines Implémentez avec succès les spécifications techniques du projet ROOT → 3 semaines de tutoriels détaillés pour le projet ROOT → 4 semaines détaillées
Livrables et consignes pour réussir : Documentation utilisateur unifiée unique sans lacunes Documentation utilisateur entièrement mise à jour pour refléter les dernières fonctionnalités, c'est-à-dire les nouvelles classes dérivées Tutoriels via des notebooks Jupyter