Créer la proposition d'organisation

Phase actuelle:
Les candidatures de l'organisation sont ouvertes. Consultez le calendrier.

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 la proposition. "Améliorations de la documentation" est trop vague ; "Mettre à jour les sections 5, 7, 23 et 99 des sections "Guide des contributeurs", "Créer des questions fréquentes" et "Créer un guide de style" est trop longue.

À propos de votre organisation

Dans cette section, décrivez-nous votre organisation ou votre projet en quelques paragraphes. Quel problème votre projet résout-il ? Qui sont vos utilisateurs et contributeurs ? Depuis combien de temps votre organisation ou votre projet existe-t-il ? Donnez-nous des informations pour nous aider à comprendre pourquoi le financement de votre proposition aurait 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 ratio parfait de sel, sucre, vinaigre et épices pour chaque légume à cornicher, en quantités allant d'un seul petit concombre solitaire à des conteneurs de radis. Nos contributeurs sont des amateurs de pickles du monde entier. Nos utilisateurs sont des cuisiniers amateurs, des cuisiniers de restaurants et des personnes travaillant dans la logistique pour de grandes entreprises et organisations de traitement alimentaire. Notre plus grand utilisateur est une organisation qui aide les banques alimentaires à transformer des légumes de courte durée en pots de pickles stables, ce qui contribue à nourrir les personnes affamées dans de nombreuses communautés et à réduire le gaspillage alimentaire. De plus, nos utilisateurs nous envoient des métriques facultatives sur leur utilisation de GloriousPickle, que nous utilisons pour produire le PickleSet, un vaste ensemble de données permettant de créer des recettes de pickle par machine learning.

À propos de votre projet

Le problème de votre projet

Décrivez-nous le problème que votre projet permettra de 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 les nouvelles épices et d'autres ingrédients (en particulier les ingrédients de cuisines non européennes) à l'outil GloriousPickle. Malheureusement, le processus d'ajout de ces informations n'est pas bien documenté, ce qui signifie que les contributeurs potentiels doivent signaler un problème dans le projet pour obtenir de l'aide (ou simplement abandonner complètement). Le processus part du principe que les contributeurs connaissent déjà notre processus de demande d'extraction et GitHub, bien que nombre de nos utilisateurs ne soient pas des développeurs professionnels.

Plus nous disposons d'informations sur les ingrédients, plus le GloriousPickle sera utile à tous nos utilisateurs !

La portée de votre projet

Indiquez-nous les documents que votre organisation va créer, mettre à jour ou améliorer. Si une partie du travail n'est délibérément pas effectuée, incluez également cette information. Indiquez une estimation du temps, et indiquez si vous avez déjà identifié des bénévoles et un rédacteur technique pour votre projet.

Le projet GloriousPickle (nommé de code PicklePlus) offre les avantages suivants:

  • Auditez la documentation existante et créez un journal de friction de la documentation actuelle pour les trois principaux cas d'utilisation (ajout d'un nouvel ingrédient, ajout d'une variante, et mise à jour ou correction des informations sur un ingrédient).
  • En vous servant du journal des frictions comme guide pour comprendre les lacunes de la documentation, créez une documentation à jour pour les principaux cas d'utilisation.
  • Créez un "aide-mémoire" rapide pour aider les contributeurs qui découvrent les demandes d'extraction et sur GitHub pour les aider à utiliser notre processus.
  • Intégrez les commentaires des testeurs de la documentation (bénévoles dans le projet) et de la communauté GloriousPickle dans son ensemble.
  • Travailler avec l'équipe de publication pour mettre à jour la documentation sur le site GloriousPickle et créer un processus pour synchroniser la documentation avec l'outil de mise à jour à l'avenir.

Travail qui est en dehors de la portée de ce projet:

  • Ce projet ne créera pas de processus de liaison croisée entre différentes orthographes ou noms pour le même ingrédient.
  • Ce projet ne créera pas de tutoriels GitHub ; à la place, l’aide-mémoire redirigera vers des documents existants pertinents et utiles.

Nous avons deux grands candidats à la rédaction technique pour ce projet, et nous estimons que ce travail prendra trois mois. Le GloriousPickle PickleDocs SIG et @GloriousPicklePat (le responsable principal 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 si votre nouvelle documentation a aidé à résoudre votre problème ? Quelles métriques allez-vous utiliser et comment allez-vous les suivre ?

GloriousPickle reçoit en moyenne 10 demandes d'extraction par trimestre pour ajouter ou modifier de nouveaux ingrédients (avec le tag "ingrédient"). La majorité de ces demandes d'extraction (plus de 60%) proviennent d'anciens contributeurs. Nous pensons que cette amélioration de la documentation entraînera davantage de demandes d'extraction de la part des nouveaux contributeurs. Puisque la plupart de nos contributeurs actifs ont commencé par ajouter des ingrédients, nous pensons également que l'amélioration de cette documentation se traduira par un plus grand nombre de contributeurs actifs.

Nous suivrons deux métriques (le nombre de demandes d'extraction liées aux ingrédients et le nombre de demandes d'extraction des nouveaux contributeurs) tous les mois après la publication de la documentation. Nous suivrons également le nombre de contributeurs ayant apporté plus de trois contributions au total, à partir d'un trimestre après la publication de la documentation.

Nous considérerons le projet comme 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 demandes d'extraction provenant de nouveaux contributeurs augmente de 15 %.
  • Le nombre de contributeurs ayant apporté plus de trois contributions augmente de 10% (à partir du trimestre suivant la publication de la documentation).

Chronologie

Selon vous, combien de temps prendra cette tâche ? Pouvez-vous répartir les tâches de rédacteur technique par mois ou par semaine ?

Le projet en lui-même prendra environ six mois. Une fois le rédacteur technique embauché, nous consacrerons un mois à l'orientation, puis nous passerons au journal d'audit et de friction, et nous consacrerons les derniers mois à la création de la documentation.

Dates À traiter
Mai Intégration
Juin – Août Auditer la documentation existante et créer un journal de friction
Septembre – Octobre Créer une documentation
Novembre Achèvement du projet

Budget du projet

Consignes générales

  • Vous pouvez inclure votre budget dans votre proposition ou sous forme de lien distinct. Si votre budget est inférieur à 10 éléments, nous vous recommandons de l'inclure dans votre proposition.
  • Tous les budgets doivent être libellés en dollars américains. Les subventions devraient varier de 5 000 à 15 000 USD. Si votre projet dépasse ces limites, veuillez fournir des informations supplémentaires pour justifier votre budget.
  • Nous prévoyons que la majeure partie de votre budget (60 à 70% minimum) sera allouée au rédacteur technique qui travaille sur votre projet. Nous vous recommandons de définir une budgétisation par projet dans la mesure du possible.
  • Dans la mesure du possible, les projets Open Source doivent utiliser des outils Open Source. Si votre projet a absolument besoin de fonds pour des licences logicielles propriétaires ou une assistance, veuillez justifier le montant en question.
  • Voici d'autres dépenses possibles :
    • Travail de conception pour créer une image de marque, des logos, des modèles ou d'autres actifs de conception pour votre site de documentation
    • Montants minimaux (< 200 USD) pour les goodies du projet (t-shirts ou autocollants pour vos participants). Si vous utilisez le logo de la saison des documents Google, celui-ci doit être accompagné du logo ou du nom de votre projet ou organisation. Vous ne pouvez pas utiliser le nom "Google".
    • Une bourse minimale pour les bénévoles qui assument des fonctions de mentorat ou d'orientation considérables dans le cadre du projet (nous recommandons de ne pas dépasser 500 dollars par bénévole, s'il vous plaît).
    • Les dons en aval destinés à d'autres projets Open Source ne doivent pas dépasser 10% du total de votre budget.
  • Indiquez d'autres postes budgétaires si nécessaire, ainsi qu'une justification du montant demandé. Les justifications des dépenses doivent mettre en évidence la manière dont les dépenses contribueront à la réussite du projet dans son ensemble.

Exemple de budget

Élément de budget Montant Total cumulé Remarques/justifications
Le rédacteur technique audite, met à jour, teste et publie une nouvelle documentation sur le processus d'ajout d'ingrédients pour GloriousPickle. 5 000,00 5 000,00
Bénévoles 500 6 500,00 3 bourses de 500 bénévoles chacune
T-shirts du projet (10 t-shirts) 150,00 6650,00
Licorne géante gonflable (version 4,7 m) 99,99 6 749,99 Nous donnerons la licorne gonflable à l'équipe qui répondra le plus rapidement aux questions du rédacteur technique pendant la période de développement du projet
TOTAL 6 749,99

Informations complémentaires

Indiquez ici toutes les informations supplémentaires pertinentes pour votre proposition.

  • Expérience préalable 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 avez développé de la documentation, mentionnez-le dans votre candidature. Décrivez la documentation que vous avez créée et la manière dont vous avez travaillé avec le rédacteur technique. Par exemple, décrivez tous les processus de révision que vous avez utilisés ou en quoi les compétences du rédacteur technique ont été utiles à votre projet. Expliquez en quoi cette expérience peut vous aider à travailler avec un rédacteur technique dans Google Season of Docs.

  • Participation antérieure à Google Season of Docs, Google Summer of Code ou d'autres programmes: Si vous ou l'un de vos mentors avez participé à 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 dans Google Season of Docs.