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:
- LuckInTheRain
- Nom du projet:
- Extension et amélioration de la documentation ROOT
- Durée du projet:
- Longue durée (cinq mois)
Project description
L'objectif du projet est d'améliorer la documentation de ROOT, qui est le principal système logiciel d'analyse et de présentation des données utilisé par la communauté de physique des hautes énergies dans le monde entier.
En plus des compétences de rédacteur technique que je peux apporter au projet, je suis également familiarisé avec ROOT (6 et 7) et je connais d'autres composants requis par le projet, tels que:
- C++
- Python
- Git/GitHub
- Outils de création de sites Web (HTML, Markdown, Jekyll)
Je vois trois éléments principaux dans la documentation ROOT:
- le site Web https://root.cern,
- le guide de référence des classes C++ : https://root.cern/doc/master/
- le forum https://root-forum.cern.ch
Il me semble que la documentation ROOT (le nouveau "manuel ROOT") doit être améliorée et complétée dans les domaines suivants:
- Il devrait devenir plus accessible et compréhensible pour les non-physiciens, en particulier les chapitres introductifs.
- D'autres tutoriels expliquant les fonctionnalités générales de ROOT seront développés.
- Certains nouveaux sujets et développements doivent être inclus, avec des descriptions et des exemples détaillés.
Voici quelques exemples :
- Liaisons Python
- Les bibliothèques mathématiques
- Description manuelle des outils graphiques de haut niveau (TRatioPLot, THStack)
- Les nouveaux outils d'analyse de l'exploration de données (RDataFrame et RNtuple)
- Les nouveaux formats de données clés (RDataFrame et RNtuple) nécessitent des spécifications techniques et des tutoriels détaillés.
Les réponses aux questions importantes des utilisateurs, telles que celles publiées sur le forum ROOT, devront être incluses dans la documentation. Pour ce faire, nous avons besoin d'une analyse fine des questions les plus fréquentes, suivie d'une période de synthèse pour les traduire en éléments de documentation dans le nouveau manuel ROOT ou dans de nouveaux tutoriels du guide de référence.
Tutoriels illustrant les fonctionnalités fournies par ROOT 7.
- Nouveaux histogrammes ROOT 7
- Nouveaux graphiques ROOT 7
Calendrier estimé (5 mois):
- Phase 1: Définition des tâches et de la portée de la documentation et des tutoriels ROOT: 2 semaines.
- Phase 2: Recueillir et analyser les questions importantes des utilisateurs sur le forum ROOT: deux semaines
- Phase 3: Rédaction de la documentation ROOT: huit semaines.
- Phase 4: Élaboration de tutoriels: huit semaines
Enfin, je voudrais ajouter que j'ai déjà contribué à la documentation ROOT l'année dernière avec un projet Google Season of Docs à long terme. J'ai défini la nouvelle structure du manuel. La proposition de cette année contribuera à finaliser d'autres aspects de la documentation qui manquent encore dans ROOT.