CERN-HSF-Projekt

Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.

Projektzusammenfassung

Open-Source-Organisation:
CERN-HSF
Technischer Redakteur:
LuckInTheRain
Projektname:
ROOT-Dokumentation erweitern und verbessern
Projektdauer:
Langfristig (5 Monate)

Projektbeschreibung

Ziel des Projekts ist die Verbesserung der Dokumentation von ROOT, dem wichtigsten Softwaresystem für die Datenanalyse und Datenpräsentation, das von der energiegeladenen Physik-Community weltweit verwendet wird.

Abgesehen von den Fähigkeiten als technischer Redakteur, die ich für das Projekt einbringen kann, bin ich auch mit ROOT (6 und 7) vertraut und habe Kenntnisse über andere Komponenten, die für das Projekt erforderlich sind, wie z. B.:

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

Ich erkenne drei Hauptbestandteile in der ROOT-Dokumentation:

  • die Website https://root.cern
  • C++-Referenzhandbuch unter https://root.cern/doc/master/
  • 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 auch für Personen ohne Physiker zugänglicher und verständlicher werden, insbesondere in den Einführungskapiteln.
  • Weitere Tutorials zur Erläuterung der allgemeinen Funktionalität von ROOT sollen entwickelt werden.
  • Einige neue Themen und Entwicklungen werden mit detaillierten Beschreibungen und Beispielen aufgenommen. Hier einige Beispiele:
    • Die Python-Bindung
    • Mathematische Bibliotheken
    • Manuelle Beschreibung für anspruchsvolle Grafiktools (TRatioPLot, THStack)
    • Die neuen Tools für die Data-Mining-Analyse (RDataFrame und RNtuple)
  • Die neuen wichtigen Datenformate RDataFrame und RNtuple erfordern detaillierte technische Spezifikationen und Anleitungen.

  • Antworten auf wichtige Fragen von Nutzern, z. B. solche, die im ROOT-Forum gepostet wurden, müssen in der Dokumentation enthalten sein. Dazu ist eine detaillierte Analyse der am häufigsten gestellten Fragen erforderlich, gefolgt von einem Synthesezeitraum, um sie in Dokumentationen im neuen „ROOT-Handbuch“ oder in neuen Anleitungen im Referenzhandbuch zu übersetzen.

  • Anleitungen, die die von ROOT 7 bereitgestellten Funktionen veranschaulichen.

    • Neue ROOT 7-Histogramme
    • Neue ROOT 7-Grafiken

Geschätzter Zeitaufwand (5 Monate):

  • Phase 1: Definition von Aufgaben und Umfang für ROOT-Dokumentation und -Anleitungen: 2 Wochen.
  • Phase 2: Sammeln und Analysieren der Fragen wichtiger Nutzer aus dem ROOT-Forum: 2 Wochen
  • Phase 3: Schreiben der ROOT-Dokumentation: 8 Wochen.
  • Phase 4: Tutorials entwickeln: 8 Wochen

Zu guter Letzt möchte ich noch hinzufügen, dass ich letztes Jahr bereits mit einem langfristigen Google Season of Docs-Projekt an der ROOT-Dokumentation mitgewirkt habe. Ich habe die neue Struktur des Handbuchs definiert. Der diesjährige Vorschlag trägt dazu bei, dass auch andere Dokumentationsaspekte berücksichtigt werden, die in ROOT noch fehlen.