Projekt OpenJS Foundation
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Ta strona zawiera szczegóły projektu technicznego do pisania
w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source
- OpenJS Foundation
- Specjalista ds. technicznych:
- Światło
- Nazwa projektu:
- Zaktualizowane dokumenty Fastify
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Skupię się na 2 obszarach. Jednym z nich jest stworzenie przewodnika stylistycznego, który obejmuje również zmianę struktury obecnej dokumentacji w fastify.io, dzięki czemu nowi użytkownicy będą mogli z łatwością je poznać. Drugim jest poprawa jakości treści generowanych przez fastify, aby nowi autorzy nie mieli wątpliwości i nie wpadli w zamęt. Najlepiej byłoby, gdyby udało się utworzyć jasną i zwięzłą ścieżkę od pierwszego kontaktu po zapoznanie się z działaniem Fastify.
Ten projekt będzie przebiegał w 4 etapy.
Najpierw musisz zapoznać się z dostępnymi kompleksowymi narzędziami i lepiej zrozumieć obecne potrzeby związane z dokumentacją.
Celem drugiej fazy będzie uporządkowanie, sprecyzowanie i ustalenie priorytetów w kontekście celów Fastify na potrzeby tego projektu GSoD. Następnie rozpocznie się faza wdrażania, która będzie obejmować kontakt z mentorami i społecznością deweloperów Fastify w celu uzyskania opinii.
Ostatnim krokiem będzie sprawdzenie i poprawienie projektu w razie potrzeby oraz napisanie raportu.
Postaram się, aby ten projekt open source odniósł sukces.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2024-11-08 UTC.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 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"]]
