OpenJS Foundation-Projekt
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
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.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2024-11-08 (UTC).
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Benötigte Informationen nicht gefunden","missingTheInformationINeed","thumb-down"],["Zu umständlich/zu viele Schritte","tooComplicatedTooManySteps","thumb-down"],["Nicht mehr aktuell","outOfDate","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Problem mit Beispielen/Code","samplesCodeIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2024-11-08 (UTC)."],[[["This project aims to improve the Fastify documentation by creating a style guide and restructuring existing content for better user experience."],["The project also focuses on enhancing contributor documentation to streamline the contribution process for new contributors."],["It's a 3-month Google Season of Docs project under the OpenJS Foundation, with Light as the technical writer."],["The project will involve familiarization, planning, implementation with community feedback, and final review stages."]]],["The technical writing project focuses on overhauling the Fastify documentation for the OpenJS Foundation. Key actions include creating a style guide, restructuring the existing documentation, and enhancing contribution content to improve clarity for new users. The project involves four phases: familiarization with tools and needs, structuring and prioritizing Fastify's goals, implementation with community feedback, and final review and reporting. The aim is to streamline the path from first-time contribution to understanding Fastify.\n"]]
