Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Chat d'équipe Open Source Zulip
- Rédacteur technique:
- drrosa
- Nom du projet:
- Réfactorisation de ReadTheDocs et de la documentation de l'API
- Durée du projet:
- Durée standard (trois mois)
Project description
Je vais me concentrer sur deux domaines en parallèle. L'un d'entre eux consiste à améliorer la qualité de zulip.readthedocs.io afin que les nouveaux contributeurs rencontrent moins de confusion et de doutes en cours de route. Idéalement, le résultat sera un parcours clair et concis, de la première contribution à la familiarisation avec le fonctionnement de Zulip. Je prévois également de travailler sur zulipchat.com/api, api.md et openapi.md afin de faciliter la documentation des points de terminaison supplémentaires. Les deux parties impliquent probablement de mettre à jour/simplifier le contenu, de désencombrer les articles, d'ajouter la documentation des développeurs manquante et d'écrire/tester du code.
Le projet se compose de quatre phases. La première phase comprendra de petits projets de familiarisation, des outils préparatoires et une meilleure compréhension des besoins actuels en matière de documentation. L'objectif de la deuxième phase sera de structurer, de spécifier et de hiérarchiser le travail en fonction des objectifs de Zulip cet automne. Je vais ensuite passer à la phase d'implémentation du projet. Je vais échanger avec les mentors et le reste de la communauté des développeurs de Zulip pour obtenir des commentaires. La phase finale consiste à revenir en arrière, à réviser si nécessaire et à rédiger le rapport du projet.
Je pense que certaines priorités et tâches sont susceptibles de changer au cours de la période de travail en fonction de ce sur quoi tout le monde travaille, y compris des décisions prises par les développeurs principaux. Je pense que l'apprentissage de l'adaptation à ces changements sera un aspect nécessaire pour réussir votre expérience GSoD. Il est possible qu'à un moment donné, il soit judicieux de reporter les idées proposées pour plus tard. De manière générale, je vais m'assurer que mon travail contribue à la réussite globale du projet open source Zulip.