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:
- Zulip Open Source-Teamchat
- Technischer Redakteur:
- drrosa
- Projektname:
- Refactoring von ReadTheDocs und API-Dokumenten
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Ich werde mich auf zwei Bereiche konzentrieren und parallel daran arbeiten. Eine davon ist die Verbesserung der Qualität von zulip.readthedocs.io, damit neue Mitwirkende weniger Verwirrung und Zweifel haben. Idealerweise ist das Ergebnis ein klarer und prägnanter Pfad, der von einem ersten Beitrag bis hin zur Bedienung von Zulip führt. Ich habe vor, auch auf zulipchat.com/api, api.md und openapi.md zu arbeiten, um die Dokumentation weiterer Endpunkte verständlicher zu machen. Beide Teile umfassen wahrscheinlich die Aktualisierung/Vereinfachung von Inhalten, das Entfernen von unnötigen Elementen aus Artikeln, das Hinzufügen fehlender Entwicklerdokumentation und das Schreiben/Testen von Code.
Das Projekt besteht aus vier Phasen. Die erste Phase umfasst kleine Projekte zur Einarbeitung, vorbereitende Tools und ein besseres Verständnis der aktuellen Dokumentationsanforderungen. Ziel der zweiten Phase ist es, die Arbeit im Kontext der Ziele von Zulip in diesem Herbst zu strukturieren, zu spezifizieren und zu priorisieren. Anschließend geht es mit der Umsetzungsphase des Projekts weiter. Ich werde mich mit Mentoren und der restlichen Entwicklergemeinschaft von Zulip austauschen, um Feedback zu erhalten. In der letzten Phase geht es darum, zurückzublicken, nach Bedarf Änderungen vorzunehmen und den Projektbericht zu verfassen.
Ich vermute, dass sich einige Prioritäten und Aufgaben im Laufe der Arbeitsphase aufgrund der Arbeit der anderen ändern werden, einschließlich der Entscheidungen der Kernentwickler. Ich gehe davon aus, dass es für einen erfolgreichen GSoD-Kurs unerlässlich ist, zu lernen, wie man sich gut an solche Änderungen anpasst. Es kann sein, dass es sinnvoll ist, vorgeschlagene Ideen auf später zu verschieben. Generell werde ich darauf achten, dass meine Arbeit zum Erfolg des Open-Source-Projekts Zulip beiträgt.