Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- CERN-HSF
- Technical Writer:
- LuckInTheRain
- Nome del progetto:
- Ampliare e migliorare la documentazione di ROOT
- Durata del progetto:
- A lungo termine (5 mesi)
Project description
Il progetto ha lo scopo di migliorare la documentazione di ROOT, il sistema software principale per l'analisi e la presentazione dei dati utilizzato dalla comunità di fisica delle alte energie in tutto il mondo.
Oltre alle competenze di autore di manuali tecnici che posso fornire per il progetto, ho familiarità anche con ROOT (6 e 7) e conosco altri componenti richiesti dal progetto, ad esempio:
- C++
- Python
- Git/GitHub
- Strumenti per la creazione di siti web (HTML, Markdown, Jekyll)
Nella documentazione di ROOT identifico tre componenti principali:
- il sito web https://root.cern,
- la guida di riferimento alle classi C++ https://root.cern/doc/master/,
- il forum https://root-forum.cern.ch
Mi sembra che la documentazione ROOT (il nuovo "manuale ROOT") debba essere migliorata e integrata nelle seguenti aree:
- Dovrebbe diventare più accessibile e comprensibile per i non fisici, in particolare i capitoli introduttivi.
- Verranno sviluppati altri tutorial che spiegano la funzionalità generale di ROOT.
- Saranno inclusi alcuni nuovi argomenti e sviluppi con descrizioni ed esempi dettagliati.
Tra quelli che posso elencare:
- Il binding di Python
- Le librerie matematiche
- Descrizione manuale per gli strumenti grafici di alto livello (TRatioPLot, THStack)
- I nuovi strumenti di analisi del data mining (RDataFrame e RNtuple)
- I nuovi formati di dati chiave (RDataFrame e RNtuple) richiedono specifiche tecniche e tutorial dettagliati.
Le risposte a domande importanti degli utenti, come quelle pubblicate nel forum ROOT, dovranno essere incluse nella documentazione. Ciò richiede un'analisi accurata delle domande più frequenti seguite da un periodo di sintesi per tradurle in parti di documentazione nel nuovo "Manuale ROOT" o in alcuni nuovi tutorial nella Guida di riferimento.
Tutorial che illustrano le funzionalità fornite da ROOT 7.
- Nuovi istogrammi di ROOT 7
- Nuova grafica di ROOT 7
Pianificazione del tempo stimato (5 mesi):
- Fase 1: definizione delle attività e dell'ambito per la documentazione e i tutorial ROOT: 2 settimane.
- Fase 2: raccogliere e analizzare le domande importanti degli utenti del forum ROOT: 2 settimane
- Fase 3: stesura della documentazione ROOT: 8 settimane.
- Fase 4: sviluppo di tutorial: 8 settimane
Infine, devo aggiungere che ho già contribuito alla documentazione di ROOT lo scorso anno con un progetto a lungo termine di Google Season of Docs. Ho definito la nuova struttura del manuale. La proposta di quest'anno contribuirà al completamento di altri aspetti della documentazione ancora mancanti in ROOT.