Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- CERN-HSF
- Specjalista ds. technicznych:
- 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, czyli głównego systemu oprogramowania do analizy i prezentacji danych używanego przez społeczność fizyki cząstek elementarnych na całym świecie.
Oprócz umiejętności technicznych, które mogę zaoferować w ramach projektu, znam się też na ROOT (wersje 6 i 7) oraz inne komponenty wymagane w projekcie, takie jak:
- C++
- Python
- Git/GitHub
- Narzędzia do tworzenia witryn (html, markdown, Jekyll)
W dokumentacji ROOT wyróżniam 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 (nowy „Przewodnik ROOT”) wymaga ulepszenia i uzupełnienia w tych obszarach:
- Powinny być też bardziej przystępne i zrozumiałe dla osób niebędących fizykami, zwłaszcza w rozdziałach wprowadzających.
- Zostanie uruchomionych więcej samouczków objaśniających ogólną funkcjonalność ROOT.
- Niektóre nowe tematy i rozwiązania powinny być opisane szczegółowo i przykładowo.
Oto niektóre z nich:
- Połączenie z Pythonem
- Biblioteki matematyczne
- Opis ręczny narzędzi do tworzenia grafik na wysokim poziomie (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, np. te zamieszczane na forum ROOT. Wymaga to dokładnej analizy najczęściej zadawanych pytań, a następnie okresu syntezy, aby przekształcić je w dokumenty w nowym „Przewodniku ROOT” lub w nowych samouczkach w przewodniku referencyjnym.
Samouczki ilustrujące funkcje dostępne w ROOT 7.
- Nowe histogramy ROOT 7
- Nowe grafiki ROOT 7
Przewidywany harmonogram (5 miesięcy):
- Etap 1. Definiowanie zadań i zakresu dokumentacji i samouczków ROOT: 2 tygodnie.
- Etap 2. Zbieranie i analizowanie ważnych pytań użytkowników z forum ROOT: 2 tygodnie
- Etap 3. Opracowanie dokumentacji ROOT: 8 tygodni.
- Etap 4. Tworzenie samouczków: 8 tygodni
Na koniec chcę dodać, że w zeszłym roku udało mi się już przygotować dokumentację ROOT w ramach długoterminowego projektu Google Season of Dokumenty. Zdefiniowałem nową strukturę podręcznika. W tym roku proponujemy uzupełnienie innych aspektów dokumentacji, których wciąż brakuje w ROOT.