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.