Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- CERN-HSF
- Pisarz techniczny:
- LuckInTheRain
- Nazwa projektu:
- Rozszerzanie i ulepszanie dokumentacji ROOT
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
Celem projektu jest ulepszenie dokumentacji ROOT, głównego systemu oprogramowania do analizy i prezentacji danych, używanego przez społeczność na całym świecie fizyki wysokich energii.
Poza umiejętnościami pisarskimi, które mogę zapewnić w ramach projektu, znam również ROOT (6 i 7), a także mam wiedzę o innych elementach wymaganych do realizacji projektu, takich jak:
- C++
- Python
- Git/GitHub
- Narzędzia do tworzenia witryn internetowych (html, Markdown, Jekyll)
W dokumentacji ROOT identyfikują 3 główne elementy:
- witryna https://root.cern,
- przewodnik po klasach C++: https://root.cern/doc/master/,
- forum https://root-forum.cern.ch
Wydaje mi się, że dokumentacja ROOT (nowa „instrukcja obsługi ROOT”) wymaga ulepszenia i uzupełnienia w tych obszarach:
- Powinny stać się bardziej przystępne i zrozumiałe dla osób niebędących fizykami, zwłaszcza rozdziały wprowadzające.
- Opracujemy więcej samouczków wyjaśniających ogólną funkcjonalność ROOT.
- Przedstawimy niektóre nowe tematy i rozwiązania wraz ze szczegółowymi opisami i przykładami.
Mogę wymienić m.in.:
- Powiązanie Pythona
- Biblioteki matematyczne
- Ręczny opis narzędzi graficznych wysokiej jakości (TRatioPLot, THStack)
- Nowe narzędzia do analizy wydobywania danych (RDataFrame i RNtuple)
- Nowe formaty kluczowych danych (RDataFrame i RNtuple) wymagają szczegółowych specyfikacji technicznych i samouczków.
W dokumentacji należy uwzględnić odpowiedzi na ważne pytania użytkowników, takie jak te opublikowane na forum ROOT. Wymaga to dogłębnej analizy najczęstszych pytań, po czym nastąpi ich synteza, aby przekształcić je w odpowiednie fragmenty dokumentacji zawartej w nowym podręczniku ROOT lub w nowych samouczkach dostępnych w tym przewodniku.
Samouczki ilustrujące funkcje oferowane przez ROOT 7.
- Nowe histogramy ROOT 7
- Nowa grafika w ROOT 7
Szacowany harmonogram (5 miesięcy):
- Etap 1. Definicja zadań i zakres w dokumentacji i samouczkach ROOT: 2 tygodnie
- Etap 2. Zbierz i przeanalizuj ważne pytania użytkowników z forum ROOT: 2 tygodnie
- Etap 3. Pisanie dokumentacji ROOT: 8 tygodni
- Etap 4. Tworzenie samouczków: 8 tygodni
Na koniec chcę wspomnieć, że w zeszłym roku współpracowałem już z dokumentacją ROOT w ramach długoterminowego projektu Google Season of Docs. Określiłem nową strukturę Podręcznika. Ta oferta w tym roku przyczyni się do uzupełnienia innych aspektów dokumentacji, których nadal brakuje w ROOT.