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:
- NumPy
- Technischer Redakteur:
- Kubedoc
- Projektname:
- Umstrukturierung auf hoher Ebene und Fokus auf Endnutzer
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
- Vorschlag:
- Erstellen und verbessern Sie allgemeine Dokumentationen – Anleitungen und How-tos – zu Themen, die in der offiziellen Dokumentation fehlen.
- Erstellen eines neuen Abschnitts „Erläuterungen“, in dem die Inhalte organisiert werden, die derzeit in der Referenzdokumentation verstreut sind.
- Ziel: Bereitstellung von Möglichkeiten, um Nutzende zu den für sie relevantesten Teilen der Dokumentation zu führen.
- Ergebnis: Verbesserung der allgemeinen Dokumentation für neue Python-Nutzer sowie erfahrene Wissenschaftler und Programmierer.
- Ich habe Erfahrung mit der Verwendung von NumPy im Kontext der numerischen Berechnung und des maschinellen Lernens (mit Pandas, PyTorch, TensorFlow und JAX).