OpenJS Foundation project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- OpenJS Foundation
- Technical writer:
- Light
- Project name:
- Overhaul Fastify Docs
- Project length:
- Standard length (3 months)
Project description
My focus will be on two areas. One of them is to achieve a style guide, which also involves the restructuring of the current documentation in fastify.io, making it easy for new users to follow through seamlessly. The other will be improving the quality of fastify contribution contents, so that new contributors run into less confusion and doubts along the way. Ideally, the result will be a clear and concise path from a first-time contribution to becoming familiar with how Fastify works.
This project will go through the following 4 phases.
First will be to familiarize with the comprehensive tools available and better understand the current documentation needs.
The goal of the second phase will be to structure, specify and give priority to the context of Fastify's goals for this GSoD
Then start the implementation phase, which involves going back and forth with mentors and the Fastify's developer community for feedback.
The final step will be to review and revise where needed and write the project report.
I will make sure to bring value to the overall success of this open-source project.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 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"]]
