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:
- Open-Source-Teamchat von Zulip
- Technischer Redakteur:
- Drrosa
- Projektname:
- ReadTheDocs und API-Dokumentation refaktorieren
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Ich werde mich auf zwei Bereiche konzentrieren und sie parallel bearbeiten. Eine davon besteht darin, die Qualität von zulip.readthedocs.io zu verbessern, damit neue Beitragende auf dem Weg weniger Verwirrung und Zweifel haben. Im Idealfall ist das Ergebnis ein klarer und prägnanter Weg, von einem ersten Beitrag bis hin zur Vertrautheit mit der Funktionsweise von Zulip. Ich habe vor, auch an zulipchat.com/api, api.md und openapi.md zu arbeiten, um die Dokumentation zusätzlicher Endpunkte leichter verständlich zu machen. In beiden Bereichen ist es wahrscheinlich, dass sie Inhalte aktualisieren/vereinfachen, Artikel aufräumen, fehlende Entwicklerdokumentation hinzufügen und Code schreiben/testen.
Das Projekt besteht aus vier Phasen. Die erste Phase umfasst kleine Kennenlernprojekte, vorbereitende Tools und ein besseres Verständnis des aktuellen Dokumentationsbedarfs. Der Zweck der zweiten Phase besteht darin, die Arbeit unter Berücksichtigung der Ziele von Zulip für die Herbstsaison zu strukturieren, festzulegen und zu priorisieren. Dann überfahre ich mit der Implementierungsphase des Projekts. Ich werde mich mit den Mentoren und dem Rest der Zulip-Entwickler-Community austauschen, um Feedback zu erhalten. Die letzte Phase besteht darin, zurückzublicken, gegebenenfalls zu überarbeiten und den Projektbericht zu verfassen.
Ich vermute, dass sich einige Prioritäten und Aufgaben im Laufe der Arbeitszeit aufgrund dessen, woran alle anderen arbeiten, ändern werden. Dazu gehören auch Entscheidungen der Hauptentwickler. Ich gehe davon aus, dass es für eine erfolgreiche GSoD-Erfahrung notwendig ist, zu lernen, wie man sich gut an solche Veränderungen gewöhnt. Möglicherweise ist es irgendwann sinnvoll, vorgeschlagene Ideen auf später zu verschieben. Im Allgemeinen werde ich mich darauf konzentrieren, dass meine Arbeit einen Mehrwert für den Gesamterfolg des Open-Source-Projekts von Zulip liefert.