Phase actuelle:
Le programme Season of Docs 2021 s'est terminé le 14 décembre 2021. Voir la chronologie.
Utilisez ce guide comme modèle pour créer la proposition de projet de votre organisation.
TITRE DE LA PROPOSITION - nom de l'organisation
Le titre de votre proposition doit être court et précis. "Mettre à jour le guide des contributeurs ORGNAME" est un bon titre pour votre proposition. "Améliorations de la documentation" est trop vague. "Mettre à jour les sections 5, 7, 23 et 99 du guide du contributeur, créer une FAQ et créer un guide de style" est trop long.
À propos de votre organisation
Dans cette section, présentez-nous votre organisation ou votre projet en quelques paragraphes. Quel problème votre projet résout-il ? Qui sont vos utilisateurs et vos contributeurs ? Depuis combien de temps votre organisation ou votre projet existe-t-il ? Expliquez-nous pourquoi le financement de votre proposition pourrait avoir un impact positif dans l'Open Source et dans le monde.
GloriousPickle (version actuelle 1.2.3, première sortie en 2009) est une bibliothèque sous licence du MIT qui permet de calculer facilement le rapport parfait de sel, de sucre, de vinaigre et d'épices pour chaque légume pouvant être cueilli, dans des quantités allant d'un concombre solitaire de bébé à des cartons de radis en conteneurs. Nos contributeurs sont des passionnés de cornichon du monde entier, et nos utilisateurs sont des cuisiniers amateurs, des restaurateurs et des personnes travaillant dans la logistique pour de grandes entreprises et organisations de transformation de l'alimentation. Notre plus grand utilisateur est une organisation qui aide les banques alimentaires à transformer les légumes à courte durée de conservation en bocaux de cornichons stables, ce qui permet de nourrir des personnes affamées dans de nombreuses communautés et de réduire le gaspillage alimentaire. En outre, nos utilisateurs nous envoient des métriques facultatives sur leur utilisation de GloriousPickle, que nous utilisons pour créer PickleSet, un grand ensemble de données permettant de créer de nouvelles recettes de cornichons grâce au machine learning.
À propos de votre projet
Le problème de votre projet
Décrivez-nous le problème que votre projet va résoudre. Pourquoi est-il important pour votre organisation ou votre projet de résoudre ce problème ?
Les utilisateurs veulent pouvoir ajouter des informations sur de nouvelles épices et d'autres ingrédients (en particulier des ingrédients de cuisines non européennes) à l'outil GloriousPickle. Malheureusement, la procédure d'ajout de ces informations n'est pas bien documentée. Par conséquent, les contributeurs potentiels doivent ouvrir un problème dans le projet pour obtenir de l'aide (ou ils abandonnent tout simplement). Le processus suppose également que les contributeurs connaissent déjà notre processus de requête pull et GitHub, bien que de nombreux utilisateurs ne soient pas des développeurs professionnels.
Plus nous disposons d'informations sur les ingrédients, plus GloriousPickle est utile pour tous nos utilisateurs.
Portée de votre projet
Indiquez-nous la documentation que votre organisation va créer, mettre à jour ou améliorer. Si certaines tâches ne sont pas effectuées délibérément, indiquez-le également. Indiquez une estimation du temps nécessaire et indiquez si vous avez déjà identifié des bénévoles et un rédacteur technique pour travailler sur votre projet.
Le projet GloriousPickle (surnommé PicklePlus) aura les objectifs suivants:
- Effectuez un audit de la documentation existante et créez un journal des frictions pour les trois principaux cas d'utilisation (ajouter un ingrédient, ajouter un ingrédient de variante et mettre à jour ou corriger des informations sur un ingrédient).
- En vous appuyant sur le journal de friction pour comprendre les lacunes de la documentation, créez une documentation à jour pour les principaux cas d'utilisation.
- Créez une "aide-mémoire" rapide pour aider les contributeurs qui ne connaissent pas les demandes d'extraction ni GitHub à utiliser notre processus.
- Intégrez les commentaires des testeurs de la documentation (bénévoles participant au projet) et de la communauté GloriousPickle.
- Travailler avec l'équipe de publication pour mettre à jour la documentation sur le site GloriousPickle et créer un processus permettant de synchroniser la documentation avec l'outil de mise à jour à l'avenir.
Travail hors de la portée de ce projet:
- Ce projet ne créera pas de processus de mise en relation entre les différentes orthographes ou dénominations d'un même ingrédient.
- Ce projet ne créera aucun tutoriel GitHub. Au lieu de cela, la fiche de triche contiendra des liens vers des ressources existantes pertinentes et utiles.
Nous avons deux candidats solides pour ce projet de rédaction technique. Nous estimons que ce travail prendra trois mois. Le groupe de travail GloriousPickle PickleDocs et @GloriousPicklePat (principal responsable de l'API d'ajout d'ingrédients) se sont engagés à soutenir le projet.
Mesurer la réussite de votre projet
Comment saurez-vous que votre nouvelle documentation vous a aidé à résoudre votre problème ? Quelles métriques allez-vous utiliser et comment les suivrez-vous ?
GloriousPickle reçoit en moyenne dix requêtes pull par trimestre pour ajouter ou mettre à jour des ingrédients (étiquetés "ingrédient"). La majorité de ces requêtes pull (>60%) proviennent de contributeurs précédents. Nous pensons que cette documentation améliorée entraînera davantage de demandes de tirage, y compris de la part de nouveaux contributeurs. Étant donné que la plupart de nos contributeurs actifs ont commencé par ajouter des ingrédients, nous pensons également que l'amélioration de cette documentation entraînera un nombre plus important de contributeurs actifs.
Nous allons suivre deux métriques (nombre de requêtes pull liées aux ingrédients et nombre de requêtes pull de nouveaux contributeurs) tous les mois après la publication de la documentation. Nous allons également suivre le nombre de contributeurs ayant apporté plus de trois contributions au total, à partir de trimestres après la publication de la documentation.
Nous considérerions que le projet est réussi si, après la publication de la nouvelle documentation:
- Le nombre de demandes d'extraction liées aux ingrédients augmente de 20%
- Le nombre de requêtes pull de nouveaux contributeurs augmente de 15%
- Le nombre de contributeurs ayant effectué plus de trois contributions augmente de 10% (à partir du trimestre suivant la publication de la documentation)
Budget du projet
Consignes générales
- Vous pouvez inclure votre budget dans votre proposition ou sous la forme d'un lien distinct. Si votre budget est inférieur à dix éléments, nous vous recommandons de l'inclure dans votre proposition.
- Tous les budgets doivent être libellés en dollars américains. Le montant des subventions est compris entre 5 000 et 15 000 USD. Si votre projet se situe en dehors de cette fourchette, veuillez fournir des informations supplémentaires afin de justifier votre budget.
- La majeure partie de votre budget (60 à 70% minimum) devrait être allouée au rédacteur technique qui travaille sur votre projet. Dans la mesure du possible, nous vous recommandons de budgétiser vos projets individuellement.
- Nous attendons des projets Open Source qu'ils utilisent des outils Open Source dans la mesure du possible. Si votre projet nécessite absolument des fonds pour des licences ou une assistance de logiciels propriétaires, veuillez justifier le montant.
- Voici d'autres dépenses possibles :
- Travail de conception pour créer un branding, des logos, des modèles ou d'autres éléments de conception pour votre site de documentation
- Des montants minimes (<200 USD) pour les goodies du projet (t-shirts ou autocollants pour vos participants) Si vous utilisez le logo de la Saison des documents, il doit être accompagné du logo ou du nom de votre projet ou de votre organisation. Vos goodies ne doivent pas porter le nom "Google".
- Indemnités minimales pour les bénévoles qui jouent un rôle de mentorat ou d'orientation important dans le projet (nous vous recommandons de ne pas dépasser 500 $par bénévole)
- Les dons en aval pour d'autres projets Open Source ne doivent pas dépasser 10% de votre budget total.
- Si nécessaire, incluez d'autres postes budgétaires en justifiant le montant recherché. Les justifications des dépenses doivent mettre en avant la façon dont les dépenses contribueront au succès du projet dans son ensemble.
Exemple de budget
| Élément budgétaire | Montant | Total cumulé | Remarques/Justifications |
|---|---|---|---|
| Révision, mise à jour, test et publication de la nouvelle documentation sur le processus d'ajout d'ingrédients pour GloriousPickle par un rédacteur technique | 5000.00 | 5000.00 | |
| Primes de bénévolat | 500 | 6 500,00 | 3 indemnités de bénévolat de 500 € chacune |
| T-shirts du projet (10 t-shirts) | 150,00 | 6 650,00 | |
| Licorne gonflable géante (version de 4,5 m) | 99,99 | 6 749,99 | Nous remettrons le licorne gonflable à l'équipe qui répondra le plus rapidement aux questions de l'auteur technique pendant la période de développement du projet. |
| TOTAL | 6 749,99 |
Informations supplémentaires
Indiquez ici toute information supplémentaire pertinente pour votre proposition.
Expérience antérieure avec des rédacteurs techniques ou de la documentation:si vous ou l'un de vos mentors avez déjà travaillé avec des rédacteurs techniques ou développé de la documentation, mentionnez-le dans votre candidature. Décrivez la documentation que vous avez créée et les façons dont vous avez travaillé avec le rédacteur technique. Par exemple, décrivez les processus d'examen que vous avez utilisés ou comment les compétences de l'auteur technique ont été utiles à votre projet. Expliquez en quoi cette expérience antérieure peut vous aider à travailler avec un rédacteur technique lors de la Google Season of Docs.
Participation précédente à la saison des documents, au Google Summer of Code ou à d'autres programmes:si vous ou l'un de vos mentors avez participé au Google Summer of Code ou à un programme similaire, mentionnez-le dans votre candidature. Décrivez vos réussites dans ce programme. Expliquez en quoi cette expérience peut influencer votre façon de travailler pendant la Google Season of Docs.