Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- CERN-HSF
- Technischer Redakteur:
- Max
- Projektname:
- CERN-HSF – ROOT Documentation for General Audience Adoption, Dynamic Python Bindings and Tutorials
- Projektlänge:
- Lang andauernd (5 Monate)
Projektbeschreibung
CERN-HSF – ROOT-Dokumentation für die allgemeine Nutzung, dynamische Python-Bindungen und Tutorials Mentor: Olivier Couet, Axel Naumann
Zusammenfassung: Eine Dokumentation ist für die erfolgreiche und effiziente Einführung von Software durch Nutzer unerlässlich. Eine klare, genaue und umfassende Nutzerdokumentation erleichtert den Nutzern die Beherrschung der Software bei der Erreichung ihrer Ziele. Ausdrückliche Beispiele und Anleitungen sind dabei leistungsstarke Tools, mit denen Nutzer schnell lernen können.
Wenn wir die Verwendung von ROOT durch Physiker, Forscher und Entwickler im Bereich Datenanalyse und Visualisierung in der Physik untersuchen, werden wir die Vorteile einer nutzerfreundlichen und aktualisierten Dokumentation erkennen. Insbesondere aufgrund der Breite des Quellcodes und seines Wachstums kann das Dokumentationssystem von einer parallelen Weiterentwicklung profitieren, um Nutzern die Möglichkeit zu geben, das gesamte Potenzial von ROOT zu nutzen.
Zusammenfassung und Analyse der aktuellen Dokumentation Die aktuelle Nutzerdokumentation bietet einen Leitfaden, mit dem Physiker ROOT im Vergleich zu einem allgemeinen Publikum leichter einführen können. Außerdem könnten bei bestimmten Themen wie dynamischen Python-Bindungen Verbesserungen für eine umfassendere und klarere Dokumentation vorgenommen werden. Auch dem neuen Datenformat RNTuple fehlen die notwendigen detaillierten Spezifikationen. Außerdem fehlen in der aktuellen Dokumentation Anleitungen zu ROOT 7.
Methodik: Nach Rücksprache mit Olivier stellte sich heraus, dass der Schwerpunkt bei der Lösung der oben genannten Probleme darauf liegen sollte, Wissenslücken zwischen spezialisierten Forschern und einem allgemeinen Publikum zu identifizieren, Dokumentationen zu erstellen, um diese Lücke zu schließen, eine detailliertere Dokumentation der dynamischen Python-Bindungen zu verfassen, „Tutorials für moderne Analysen“ für ROOT 7 zu implementieren und detaillierte technische Spezifikationen für RNTuple zu erstellen. Während dieses Prozesses könnte die Dokumentation Jupyter Notebooks umfassen, sodass Nutzer greifbare und interaktive Lerntools nutzen können.
Zeitplan: Die Projektphasen werden voraussichtlich so ablaufen: Erkennen von Wissenslücken zwischen spezialisierten Forschern und einem allgemeinen Publikum (beim Lesen der aktuellen Dokumentation und des Quellcodes) → 1–2 Wochen Erstellen und Überarbeiten der Dokumentation, um diese Lücke zu schließen → 3 Wochen Eine detailliertere Dokumentation der dynamischen Python-Bindungen verfassen → 3 Wochen Anleitungen für dynamische Python-Bindungen implementieren → 3 Wochen Anleitungen für ROOT 7 implementieren → 4 Wochen Detaillierte technische Spezifikationen für RNTuple erstellen → 3 Wochen Prüfen, ob die Projektziele erfolgreich erreicht wurden → 1 Woche
Erforderliche Leistungen und Erfolgskriterien: Einheitliche Nutzerdokumentation ohne Lücken Vollständig aktualisierte Nutzerdokumentation, die die neuesten Funktionen widerspiegelt, z.B. neue abgeleitete Klassen Tutorials über Jupyter-Notebooks