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:
- Chat d'équipe Open Source Zulip
- Rédacteur technique:
- drrosa
- Nom du projet:
- Refactorisation de ReadTheDocs et de la documentation de l'API
- Durée du projet:
- Durée standard (3 mois)
Project description
Je vais me concentrer sur deux domaines et travailler dessus en parallèle. L'une d'elles consiste à améliorer la qualité de zulip.readthedocs.io 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 Zulip. Je prévois également de travailler sur zulipchat.com/api, api.md et openapi.md pour faciliter la compréhension du processus de documentation des points de terminaison supplémentaires. Ces deux parties impliquent généralement de mettre à jour/simplifier le contenu, de désencombrer les articles, d'ajouter la documentation pour les développeurs manquante et d'écrire/tester le code.
Le projet comportera quatre phases. La première phase consistera à mener de petits projets de familiarisation, à créer des outils préparatoires et à mieux comprendre les besoins actuels en termes de documentation. L'objectif de la deuxième phase sera de structurer, spécifier et hiérarchiser le travail dans le contexte des objectifs de Zulip pour cet automne. Je vais ensuite passer à la phase de mise en œuvre du projet. J'échangerai régulièrement avec des mentors et le reste de la communauté de développeurs Zulip pour recueillir leurs avis. La phase finale consistera à 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 raison des travaux de tous les autres, y compris des décisions prises par les développeurs principaux. Pour une expérience GSoD efficace, je pense qu'apprendre à bien s'adapter à ces changements sera nécessaire. 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 apporte de la valeur au succès global du projet Open Source Zulip.