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:
- OpenJS Foundation
- Technischer Redakteur:
- Leicht
- Projektname:
- Überarbeitung der Fastify-Dokumentation
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Ich werde mich auf zwei Bereiche konzentrieren. Eine davon ist die Entwicklung eines Styleguides. Dazu gehört auch die Neustrukturierung der aktuellen Dokumentation in fastify.io, damit neue Nutzende problemlos folgen können. Der andere wird die Qualität der Inhalte von Beiträgen zu fastify verbessern, damit neue Mitwirkende weniger Verwirrung und Zweifel haben. Idealerweise ist das Ergebnis ein klarer und prägnanter Weg von einem ersten Beitrag bis hin zur Kenntnis der Funktionsweise von Fastify.
Dieses Projekt durchläuft die folgenden vier Phasen. Als Erstes sollten Sie sich mit den verfügbaren Tools vertraut machen und die aktuellen Dokumentationsanforderungen besser verstehen. Ziel der zweiten Phase ist es, den Kontext der Ziele von Fastify für diese GSoD zu strukturieren, zu spezifizieren und zu priorisieren. Dann beginnt die Implementierungsphase, in der Sie sich mit Mentoren und der Entwickler-Community von Fastify austauschen, um Feedback zu erhalten. Der letzte Schritt besteht darin, den Projektbericht zu überprüfen und gegebenenfalls zu überarbeiten.
Ich werde meinen Beitrag zum Gesamterfolg dieses Open-Source-Projekts leisten.