Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- CERN-HSF
- Technical writer:
- LuckInTheRain
- Nome progetto:
- Estensione e miglioramento della documentazione ROOT
- Durata del progetto:
- Lunga esecuzione (5 mesi)
Project description
Il progetto ha l'obiettivo di migliorare la documentazione di ROOT, il principale sistema software per l'analisi e la presentazione dei dati utilizzato dalla comunità di fisica delle energie elevate a livello mondiale.
Oltre alle competenze di Technical Writer che posso fornire per il progetto, ho anche familiarità con ROOT (6 e 7) e ho conoscenza di altri componenti richiesti dal progetto, come:
- C++
- Python
- Git/GitHub
- Strumenti per la creazione di siti web (html, markdown, Jekyll)
Identifico tre parti principali nella documentazione ROOT:
- sul sito web https://root.cern,
- la guida di riferimento della classe 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.
- Saranno sviluppati altri tutorial che spieghino le funzionalità generali di ROOT.
- Alcuni nuovi argomenti e sviluppi verranno inclusi con descrizioni ed esempi dettagliati.
Tra questi, posso elencare:
- L'associazione Python
- Le librerie matematiche
- Descrizione manuale per strumenti grafici di alto livello (TRapportoPLot, THStack)
- I nuovi strumenti di analisi del data mining (RDataFrame e RNtuple)
- I nuovi formati dei 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 dettagliata delle domande più frequenti seguita da un periodo di sintesi per tradurle in documenti del nuovo "Manuale PRINCIPALE" o in nuovi tutorial nella Guida di riferimento.
Tutorial che illustrano le funzionalità fornite da ROOT 7.
- Nuovi istogrammi ROOT 7
- Nuova grafica ROOT 7
Pianificazione del tempo (5 mesi):
- Fase 1: definizione delle attività e dell'ambito della documentazione e dei tutorial ROOT: 2 settimane.
- Fase 2: raccolta e analisi delle domande importanti degli utenti dal forum ROOT: 2 settimane
- Fase 3. Scrittura della documentazione ROOT: 8 settimane.
- Fase 4: sviluppo dei tutorial: 8 settimane
Infine, devo aggiungere che ho già contribuito alla documentazione ROOT lo scorso anno con un progetto a lungo termine per la stagione dei documenti Google. Ho definito la nuova struttura del Manuale. La proposta di quest'anno contribuirà al completamento di altri aspetti della documentazione ancora mancanti nel ROOT.