Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- CERN-HSF
- Rédacteur technique:
- LuckInTheRain
- Nom du projet:
- Étendre et améliorer la documentation ROOT
- Durée du projet:
- Exécution longue (5 mois)
Project description
Ce projet vise à améliorer la documentation de ROOT, le principal système logiciel d'analyse et de présentation des données utilisé par la communauté mondiale de la physique des hautes énergies.
En plus des compétences de rédacteur technique que je peux fournir pour le projet, je connais également ROOT (6 et 7) et je connais d'autres composants requis par le projet, tels que:
- C++
- Python
- Git/GitHub
- Les outils de création de sites Web (html, markdown, Jekyll)
J'identifie trois éléments principaux dans la documentation ROOT:
- le site Web https://root.cern,
- le guide de référence de classe 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 d'introduction.
- D'autres tutoriels expliquant les fonctionnalités générales de ROOT seront développés.
- Certains nouveaux sujets et développements devront être inclus avec des descriptions détaillées et des exemples.
Je peux vous en citer :
- Liaison Python
- Les bibliothèques mathématiques
- Description manuelle des outils graphiques de haut niveau (TRatioPLot, THStack)
- Nouveaux outils d'analyse d'exploration de données (RDataFrame et RNtuple)
- Les nouveaux formats de données clés (RDataFrame et RNtuple) nécessitent des spécifications techniques détaillées et des tutoriels.
Les réponses aux questions importantes des utilisateurs, telles que celles publiées sur le forum ROOT, devront être incluses dans la documentation. Cela nécessite une analyse fine des questions les plus fréquentes, suivie d'une période de synthèse afin de les traduire en documents dans le nouveau "ROOT Manual" 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 graphismes ROOT 7
Calendrier estimé (5 mois):
- Phase 1: Définition des tâches et du champ d'application de la documentation et des tutoriels ROOT: deux semaines.
- Phase 2 : Collectez et analysez les questions importantes des utilisateurs sur le forum ROOT (2 semaines)
- Phase 3: Rédaction de la documentation ROOT: 8 semaines
- Phase 4 : Développement de tutoriels (8 semaines)
Enfin, je dois ajouter que j'ai déjà contribué à la documentation ROOT l'année dernière avec un projet à long terme Google Season of Docs. J'ai défini la nouvelle structure du manuel. La proposition de cette année contribuera à l’achèvement d’autres aspects de documentation encore manquants dans ROOT.