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:
- Jonas
- Projektname:
- CERN-HSF – ROOT Documentation for General Audience Adoption, Dynamic Python Bindings, and Tutorials
- Projektdauer:
- Langfristig (5 Monate)
Projektbeschreibung
CERN-HSF – ROOT Documentation for General Audience Adoption, Dynamic Python Bindings, and Tutorials Mentor: Olivier Couet, Axel Naumann
Zusammenfassung: Die Dokumentation ist unerlässlich für eine erfolgreiche und effiziente Softwareakzeptanz durch Nutzer. Eine klare, genaue und umfassende Nutzerdokumentation verbessert die Kompetenz der Nutzenden im Umgang mit der Software, während sie ihre Ziele erreichen. In diesem Zusammenhang dienen explizite Beispiele und Anleitungen als leistungsstarke Tools, mit denen die Nutzenden schnell lernen können.
Wenn wir die Verwendung von ROOT durch Physiker, Forscher und Entwickler im Bereich der Datenanalyse und Visualisierung im Bereich Physik untersuchen, werden die Vorteile einer nutzerfreundlichen und aktualisierten Dokumentation anerkannt. Vor allem aufgrund der Breite des Quellcodes und des Wachstums profitiert das Dokumentationssystem von der parallelen Weiterentwicklung, damit die Nutzenden das Beste aus ROOT herausholen können.
Zusammenfassung und Analyse der aktuellen Dokumentation Derzeit enthält die Nutzerdokumentation einen Leitfaden, der es Physikern ermöglicht, ROOT im Vergleich zu einem allgemeinen Publikum einfacher einzuführen. Darüber hinaus können bei bestimmten Themen wie dynamischen Python-Bindungen Verbesserungen für eine umfassendere und klarere Dokumentation vorgenommen werden. Ebenso fehlen dem neuen Datenformat RNTuple notwendige detaillierte Spezifikationen. Schließlich fehlen in der aktuellen Dokumentation Tutorials zu ROOT 7.
Methodik: Nach Gesprächen mit Olivier sollte der Schwerpunkt auf der Behebung der oben genannten Probleme auf der Identifizierung von Wissenslücken zwischen spezialisierten Forschern und einer allgemeinen Zielgruppe liegen, die Erstellung von Dokumentationen, um diese Lücke zu schließen, eine detailliertere Dokumentation von dynamischen Python-Bindungen, die Implementierung von „Tutorials für moderne Analysen“ für ROOT 7 und die Erstellung detaillierter technischer Spezifikationen für RNTuple. Während dieses Prozesses könnte die Dokumentation Jupyter Notebooks enthalten, sodass greifbare und interaktive Lerntools den Nutzern helfen können.
Zeitplan: Die Projektphasen werden geschätzt wie folgt: Wissenslücken zwischen spezialisierten Forschern und einer allgemeinen Zielgruppe identifizieren (während Sie die aktuelle Dokumentation und den Quellcode lesen) → 1–2 Wochen Dokumentation erstellen und refaktorieren, um diese Lücke zu schließen → 3 Wochen Detailliertere Dokumentation zu dynamischen Python-Bindungen schreiben → 3 Wochen Anleitungen für dynamische Python-Bindungen und 3 Wochen implementieren → Detaillierte Anleitungen für ROOT 7 Wochen implementieren → Detaillierte Anleitungen für ROOT 7 → 3 Wochen: Detaillierte Anleitungen für ROOT-Bindungen erstellen → 3 Wochen: Detaillierte Anleitungen für ROOT 7 Wochen implementieren
Ergebnisse und Leitlinien für den Erfolg: Einheitliche, lückenlose Nutzerdokumentation Vollständig aktualisierte Nutzerdokumentation zur Berücksichtigung der neuesten Features, z.B. neue abgeleitete Klassen Anleitungen über Jupyter Notebooks