Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- OpenJS Foundation
- Rédacteur technique:
- Léger
- Nom du projet:
- Remanier la documentation Fastify
- Durée du projet:
- Durée standard (3 mois)
Project description
Je vais me concentrer sur deux domaines. L'une d'entre elles consiste à créer un guide de style, qui implique également la restructuration de la documentation actuelle dans fastify.io, ce qui facilite la tâche des nouveaux utilisateurs. L'autre vise à améliorer la qualité de fastify du contenu des contributions, afin que les nouveaux contributeurs soient moins confus et douteux en cours de route. Idéalement, le résultat sera un chemin clair et concis, depuis une première contribution jusqu'à la prise en main du fonctionnement de Fastify.
Ce projet passera par les 4 phases suivantes. Vous commencerez par vous familiariser avec les outils complets disponibles et à mieux comprendre les besoins actuels en termes de documentation. L'objectif de la deuxième phase sera de structurer, spécifier et donner la priorité au contexte des objectifs de Fastify pour ce GSoD. Ensuite, démarrez la phase d'implémentation, qui consiste à faire des allers-retours avec les mentors et la communauté de développeurs de Fastify pour obtenir des commentaires. La dernière étape consistera à examiner et à réviser si nécessaire et à rédiger le rapport du projet.
Je veillerai à apporter de la valeur au succès global de ce projet open source.