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:
- Django
- Rédacteur technique:
- Gabbyprécieuse
- Nom du projet:
- Réécrire le guide de contribution pour le rendre plus convivial et facile à parcourir
- Durée du projet:
- Durée standard (3 mois)
Project description
EXTRAIT
L'objectif du guide de contribution de Django, comme n'importe quelle autre documentation, est de guider les utilisateurs, les contributeurs open source dans le cas présent, sur la manière et le lieu où ils peuvent contribuer à améliorer Django et à le rendre plus durable.
Il est toujours nécessaire de créer des documents, surtout ceux qui ont un impact considérable sur la communauté et Django lui-même.
Cette année, l'objectif de Django pour Google Summer of Docs est de rendre le guide des contributions moins encombrant, accessible et accueillant pour les contributeurs. Il s'agit d'un objectif essentiel car il encourage les contributeurs, auxquels j'appartiens moi-même, pour commencer à contribuer à cette structure formidable.
État actuel
L'étape actuelle de la documentation que l'on peut trouver ici n'est pas vraiment un guide, car elle est trop écrasante et mal structurée, et conduit à une 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, et il approuve que cela aidera à résoudre le problème majeur de la documentation actuelle. Voici les objectifs que je prévois d'atteindre la restructuration du document : Restructurer le document Ajouter des choses à faire et à éviter
La documentation actuelle s'adresse déjà aux contributeurs avancés et ne donne pas la possibilité aux contributeurs débutants comme débutants de l'Open Source et de Django. Voici des contenus supplémentaires pour les débutants : Section qui guide différents contributeurs(rédacteurs techniques, concepteurs et développeurs) Une page décrivant les problèmes posés par les nouveaux utilisateurs et les problèmes faciles à résoudre. Prenez quelques sections de la documentation actuelle, réécrivez-la et ajoutez-la à la section "Débutants". Les sections expliquant les points clés ou les mots utilisés dans la section avancée.
Chronologie
Voici une analyse de la façon dont je veux travailler sur l’objectif du projet, comme indiqué ci-dessus, avec le calendrier fourni par Google.
Semaine d'adhésion à la communauté( du 17 août au 13 septembre) Échanger davantage avec la communauté Continuer à contribuer à la documentation Obtenir plus de suggestions de la part des contributeurs Plus d'études sur la documentation actuelle et les outils prévus Semaines 1 à 4 Commencer la documentation sur les sections pour les niveaux
Outils
Sphinx : outil actuel utilisé pour la documentation actuelle. Lisez les documents.
Pourquoi ce projet ?
Je crois intimement qu'il existe des documentations et des articles bien rédigés qui englobent tout le monde, partout dans le monde. Par ailleurs, je suis un fan de Django et de l'Open Source dans son ensemble. J'avais l'intention de contribuer à Django en tant que débutant, et je pense que c'est le moyen idéal de contribuer à mon outil préféré, tout en me familiarisant avec le codebase pour apporter davantage de contributions en tant que développeur(et rédacteur technique). Ce sera agréable et agréable de travailler avec une organisation qui correspond à mon point de vue et qui a été un excellent outil pour toute ma carrière.
Pourquoi suis-je la personne responsable de ce projet ?
D'après les comptes suivants, je suis la bonne personne : J'ai contribué à l'élaboration de Django en rédigeant des articles destinés à aider les débutants à mieux comprendre le concept de Django. En tant que développeur et enthousiaste à l'idée de contribuer à Django, je comprends les besoins d'autres développeurs et comment bien documenter cela pour eux. J'ai l'esprit d'équipe et je vais bien travailler sous la supervision de mon mentor Carlton Gibson.