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:
- Django
- Rédacteur technique:
- Gabbyprecious
- Nom du projet:
- Réécrire le guide de contribution pour le rendre plus convivial et facile à parcourir
- Durée du projet:
- Durée standard (trois mois)
Project description
ABSTRACT
Comme toute autre documentation, le guide de contribution de Django a pour but d'indiquer aux utilisateurs, en l'occurrence aux contributeurs Open Source, comment et où ils peuvent contribuer à améliorer et à pérenniser Django.
Il est toujours nécessaire de créer des documentations, en particulier celles qui ont un impact important sur la communauté et Django lui-même.
L'objectif de Django pour l'édition 2020 du Google Summer of Docs est de rendre le guide de contribution moins intimidant, plus accessible et plus accueillant pour les contributeurs. Il s'agit d'un objectif essentiel, car il encourage les contributeurs (dont je fais partie) à contribuer à ce framework de qualité.
État actuel
L'étape actuelle de la documentation, disponible ici, n'est pas vraiment un guide, car elle est trop écrasante et mal structurée, et conduit à une moins bonne compréhension de la contribution dans Django et à un manque d'accueil pour les nouveaux contributeurs.
Objectifs du projet
J'ai discuté de mes suggestions pour la documentation avec mon mentor, Carlton Gibson, sur le forum. Il est d'accord pour dire que cela aidera à résoudre le problème majeur de la documentation actuelle. Voici les objectifs que je prévois d'atteindre en restructurant le document : Restructurer le document Ajouter des sections "À faire" et "À ne pas faire" Créer des pages uniques pour les sections triviales telles que "Demander et créer des fonctionnalités" Documentation réduite et directe Glossaire des termes Indice interne conçu pour suivre le nouveau guide Rédiger une documentation plus accessible et plus conviviale Segmenter le contenu en deux parties principales (sections "Débutants" et "Contributeurs avancés") Créer un guide et un style pour les nouveaux rédacteurs techniques/contributeurs, afin de mettre à jour la documentation et de respecter les normes.
La documentation actuelle est déjà destinée aux contributeurs expérimentés et ne permet pas aux nouveaux contributeurs et aux débutants de s'initier à l'open source et à Django. Voici quelques contenus supplémentaires pour les débutants : Section guidant différents contributeurs(rédacteurs techniques, concepteurs et développeurs) Page documentant les premiers problèmes et les problèmes faciles à résoudre. Prenez quelques sections de la documentation actuelle, réécrivez-les et ajoutez-les à la section pour les débutants. Sections expliquant les points ou les mots clés utilisés dans la section avancée.
Chronologie
Voici un récapitulatif de la façon dont je souhaite travailler sur l'objectif du projet, comme indiqué ci-dessus, avec le calendrier fourni par Google.
Semaine de renforcement des liens avec la communauté( 17 août-13 septembre) S'engager davantage avec la communauté Poursuivre la contribution à la documentation Obtenir plus de suggestions de la part des contributeurs Étudier davantage la documentation actuelle et les outils prévus Semaine 1 à 4 Commencer à diviser la documentation en sections en fonction des niveaux Créer la section pour les débutants de la documentation Semaine 4 à 6 Sélectionner les bonnes pratiques et les interdits Écrire les bonnes pratiques et les interdits par section Pages supplémentaires pour les sections Semaine 7 à 9 Réécrire et déplacer la documentation actuelle vers le guide pour les contributeurs avancés Documentation réduite Semaine 10 à 12 Préparer le glossaire Mettre à jour l'index interne avec la nouvelle documentation Créer un guide et un style pour les rédacteurs techniques/contributeurs à venir
Outils
Sphinx : outil actuel pour la documentation actuelle. Consultez la documentation.
Pourquoi ce projet ?
Je suis convaincu que les documentations et articles bien rédigés sont essentiels pour toucher tous les utilisateurs du monde entier. Par ailleurs, j'adore aussi Django et l'Open Source dans son ensemble. Je souhaite contribuer à Django en tant que débutant. Je pense que c'est un excellent moyen de contribuer à mon outil préféré, tout en me familiarisant avec le codebase pour pouvoir contribuer davantage en tant que développeur(et rédacteur technique). Ce sera agréable et agréable de travailler avec une organisation qui est en phase avec mes points de vue et qui a été un excellent outil tout au long de ma carrière.
Pourquoi suis-je la personne idéale pour ce projet ?
Je pense être la personne idéale pour ce poste, car : J'ai contribué à Django en écrivant des articles pour aider les débutants à mieux comprendre le concept de Django. En tant que développeur et j'ai hâte de contribuer à Django, je comprends le besoin d'autres développeurs et la manière de documenter cela pour eux. Je suis un joueur d'équipe et je peux travailler avec plus ou moins de supervision de la part de mon mentor, Carlton Gibson.