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:
- OpenJS-Grundlage
- Technischer Redakteur:
- Leicht
- Projektname:
- Fastify-Dokumente überarbeiten
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Ich werde mich auf zwei Bereiche konzentrieren. Eine davon ist die Entwicklung eines Styleguides, der auch die Umstrukturierung der aktuellen Dokumentation in fastify.io beinhaltet, damit neue Nutzende problemlos den Prozess verfolgen können. Außerdem wird die Qualität der Fastify-Beitragsinhalte verbessert, damit neue Beitragende weniger Unklarheiten und Zweifel haben. Im Idealfall ist das Ergebnis ein klarer und prägnanter Weg, von einem ersten Beitrag zur Einarbeitung in die Funktionsweise von Fastify.
Dieses Projekt durchläuft die folgenden vier Phasen. Als Erstes sollten Sie sich mit den verfügbaren umfassenden Tools vertraut machen und den aktuellen Dokumentationsbedarf besser verstehen. Das Ziel der zweiten Phase besteht darin, den Kontext der Ziele von Fastify für diese GSoD zu strukturieren, zu spezifizieren und Priorität zu geben. Anschließend beginnt die Implementierungsphase, in der Mentoren und die Entwickler-Community von Fastify um Feedback gebeten werden. Der letzte Schritt besteht darin, den Projektbericht zu überprüfen und gegebenenfalls zu überarbeiten und zu verfassen.
Ich werde sicherstellen, dass ich zum Gesamterfolg dieses Open-Source-Projekts beitragen wird.