CERN-HSF-Projekt

Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:
CERN-HSF
Technischer Redakteur:
LuckInTheRain
Projektname:
Erweiterung und Verbesserung der ROOT-Dokumentation
Projektdauer:
Lang andauernd (5 Monate)

Projektbeschreibung

Ziel des Projekts ist es, die Dokumentation von ROOT zu verbessern, dem wichtigsten Softwaresystem für Datenanalyse und -präsentation, das von der Hochenergie-Physik-Community weltweit verwendet wird.

Neben den Fähigkeiten als Technischer Redakteur, die ich für das Projekt anbieten kann, bin ich auch mit ROOT (6 und 7) vertraut und habe Kenntnisse über andere für das Projekt erforderliche Komponenten, z. B.:

  • C++
  • Python
  • Git/GitHub
  • Tools zum Erstellen von Websites (HTML, Markdown, Jekyll)

Ich nenne drei Hauptbestandteile in der ROOT-Dokumentation:

  • die Website https://root.cern,
  • die C++-Referenzanleitung https://root.cern/doc/master/,
  • im Forum https://root-forum.cern.ch

Anscheinend muss die ROOT-Dokumentation (das neue „ROOT-Handbuch“) in den folgenden Bereichen verbessert und ergänzt werden:

  • Sie sollte für Nicht-Physiker zugänglicher und verständlicher werden, insbesondere in den einleitenden Kapiteln.
  • Es werden weitere Anleitungen zur allgemeinen Funktionsweise von ROOT entwickelt.
  • Einige neue Themen und Entwicklungen werden mit detaillierten Beschreibungen und Beispielen aufgenommen. Dazu gehören:
    • Python-Bindung
    • Die mathematischen Bibliotheken
    • Manuelle Beschreibung für Grafiktools der höheren Ebene (TRatioPLot, THStack)
    • Die neuen Analysetools für Data Mining (RDataFrame und RNtuple)
  • Für die neuen Schlüsseldatenformate (RDataFrame und RNtuple) sind detaillierte technische Spezifikationen und Anleitungen erforderlich.

  • Antworten auf wichtige Fragen von Nutzern, z. B. solche, die im ROOT-Forum gepostet wurden, müssen in die Dokumentation aufgenommen werden. Dazu ist eine genaue Analyse der am häufigsten gestellten Fragen erforderlich, gefolgt von einer Synthesephase, um sie in Dokumentationselemente im neuen „ROOT Manual“ oder in einigen neuen Anleitungen im Referenzhandbuch zu übertragen.

  • Tutorials, in denen die Funktionen von ROOT 7 veranschaulicht werden.

    • Neue ROOT 7-Histogramme
    • Neue ROOT 7-Grafik

Geschätzter Zeitplan (5 Monate):

  • Phase 1: Definition der Aufgaben und des Umfangs der ROOT-Dokumentation und ‑Anleitungen: 2 Wochen.
  • Phase 2: Wichtige Fragen von Nutzern aus dem ROOT-Forum erfassen und analysieren: 2 Wochen
  • Phase 3: ROOT-Dokumentation schreiben: 8 Wochen
  • Phase 4: Anleitungen entwickeln: 8 Wochen

Ich möchte noch hinzufügen, dass ich bereits im letzten Jahr mit einem langfristigen Google Season of Docs-Projekt zur ROOT-Dokumentation beigetragen habe. Ich habe die neue Struktur des Handbuchs definiert. Der diesjährige Vorschlag wird zur Ergänzung anderer Dokumentationsaspekte beitragen, die in ROOT noch fehlen.