Phase actuelle:
Finalisation du projet. Voir la chronologie.
Ce guide s'adresse aux administrateurs d'organisations qui participent ou s'inscrivent au programme Google Season of Docs.
Votre organisation doit-elle participer au programme Google Season of Docs ?
Utilisez ces questions pour déterminer si votre projet ou votre organisation Open Source doivent participer à la Google Season of Docs.
Votre organisation ou votre projet:
- Pensez-vous qu'une documentation nouvelle ou mise à jour aiderait à atteindre un objectif ou à résoudre un problème dans votre projet ou votre communauté ?
- Avez-vous une compréhension initiale ou une hypothèse sur la façon dont vous mesureriez le succès de votre projet de documentation ?
- Les membres de la communauté sont-ils prêts à aider à recruter, évaluer et intégrer un rédacteur technique, et à répondre aux questions et à fournir d'autres services d'assistance pendant le projet (6 à 8 mois, y compris la période de candidature) ?
- Un membre de la communauté est-il prêt à jouer le rôle d'administrateur de l'organisation et à coordonner la création de l'application, à répondre aux questions des administrateurs du programme, et à envoyer les évaluations mensuelles, l'évaluation finale et l'étude de cas ? L'administrateur de l'organisation doit également être disposé à répondre aux enquêtes de suivi après la fin du programme Google Season of Docs.
Votre organisation doit également respecter les conditions d'éligibilité au programme, y compris être en mesure de créer un compte Open Collective.
Procédure d'inscription des organisations
Le processus de candidature d'une organisation comporte deux phases: la phase d'exploration et la phase de candidature.
Phase d'exploration
Bien que les candidatures à la Google Season of Docs ouvrent le 22 février 2024, nous recommandons vivement aux organisations de prendre le temps de suivre les étapes de la phase d'exploration avant d'envoyer leur candidature.
- Créez une page de proposition de projet. La page de proposition comprend une liste des principaux besoins, objectifs ou problèmes, des solutions de documentation possibles et des métriques possibles. Cette page doit être publique et permettre à la communauté de contribuer et de discuter. Incluez des informations pour les rédacteurs techniques qui souhaitent participer. Où peuvent-ils poser des questions, exprimer leur intérêt ou en savoir plus sur votre projet ? Nous vous suggérons d'ajouter une adresse e-mail pour contacter votre organisation Open Source au sujet de la Google Season of Docs. Toutefois, nous vous déconseillons vivement d'utiliser une adresse e-mail personnelle pour contacter votre organisation Open Source. (Pour obtenir des exemples, consultez la liste d'idées de projets.)
- Faites connaître votre page de proposition sur vos canaux de communauté et ajoutez votre organisation à la liste des organisations intéressées dans le dépôt GitHub de la Google Season of Docs. Vous pouvez également partager votre lien dans le canal #season-of-docs du Slack Write The Docs. La page de promotion et de presse inclut des logos et d'autres contenus que vous pouvez utiliser lorsque vous parlez de la Google Season of Docs.
- Pour chaque idée de documentation, réfléchissez à l'expérience et aux qualifications dont un rédacteur technique aurait besoin pour travailler efficacement avec votre communauté et votre organisation. Quelles compétences votre communauté pourrait-elle aider un rédacteur technique à développer (par exemple, en utilisant GitHub ou votre chaîne d'outils de documentation) ? (Consultez le guide sur la collaboration avec des rédacteurs techniques.
- Demandez aux volontaires de répondre aux questions des rédacteurs techniques intéressés.
- Commencez à examiner les déclarations d'intérêt envoyées par les rédacteurs techniques intéressés par votre projet.
Phase d'application
- Choisissez l'idée la plus prometteuse sur la page de votre proposition. Chaque organisation ne peut envoyer qu'une seule proposition. Voici quelques points à prendre en compte :
- Quelle idée a suscité le plus d'intérêt de la part des rédacteurs techniques ?
- Quelle idée vous aidera à résoudre le plus gros problème de votre projet ? Il est préférable de choisir une idée plus risquée qui aurait un impact plus important qu'une idée de projet de documentation plus susceptible d'être menée à bien, mais qui n'aura pas d'impact significatif sur votre projet.
- L'idée nécessite-t-elle la participation de membres spécifiques de votre communauté ? A-t-il le temps de participer ?
Créez votre proposition à l'aide du modèle de proposition. Assurez-vous de comprendre et d'inclure les éléments suivants:
- Le problème que vous souhaitez résoudre
- Étendue de la documentation que vous souhaitez améliorer ou créer
- Comment mesurer la réussite de votre documentation
Votre proposition doit également inclure un budget. Les propositions incomplètes ne seront pas prises en compte.
Envoyez le formulaire de demande avant la date limite d'inscription, le 2 avril 2024 à 18h UTC. Les propositions acceptées seront annoncées le 10 avril 2024.
Développement de projets et création de rapports
Les administrateurs de l'organisation doivent comprendre leurs responsabilités à chaque phase du programme.
Lancement du projet
- Si votre organisation a déjà sélectionné un ou plusieurs rédacteurs techniques pour votre projet, organisez une réunion de lancement avec eux. Vous devez collaborer avec votre rédacteur technique pour établir un calendrier de travail et des points de contrôle réguliers.
- Si vous avez reçu plusieurs déclarations d'intérêt de rédacteurs techniques intéressés, annoncez publiquement votre sélection de rédacteur technique ou informez les candidats de votre décision.
Paiements de subventions
- La Google Season of Docs versera 40% des fonds de la subvention sur le compte Open Collective de chaque organisation après qu'elle aura embauché un rédacteur technique, à partir du 11 juin 2024. Nous recommandons aux organisations de créer un calendrier de paiement avec les rédacteurs techniques en fonction des jalons du projet, y compris un paiement au lancement du projet.
- Les 60% restants seront versés sur les comptes Open Collective des organisations qui termineront et enverront leurs évaluations et études de cas finales à partir du 13 décembre 2024. Tous les projets réussis commenceront à recevoir le paiement final le 13 décembre 2024.
- Pour en savoir plus sur la création d'un compte Open Collective, consultez le guide des paiements.
Rapports sur l'état du projet
- Les administrateurs de l'organisation doivent remplir les rapports mensuels d'état dans la semaine qui suit la réception du lien vers le formulaire de rapport d'état (le lien sera envoyé par e-mail. Vérifiez votre dossier de spam si vous ne l'avez pas reçu).
Évaluation finale du projet et étude de cas
Les organisations doivent terminer et envoyer l'évaluation finale du projet et l'étude de cas avant le 10 décembre 2024 à 18h UTC pour recevoir le reste des fonds de la subvention.
Évaluation finale
Les formulaires d'évaluation finale et d'étude de cas seront disponibles pour les administrateurs de l'organisation au moins un mois avant le 10 décembre 2024 à 18h UTC.
Étude de cas
L'étude de cas Google Season of Docs est le principal livrable de la participation de votre organisation à Google Season of Docs. Tenir un journal hebdomadaire des mises à jour du projet vous aidera à créer votre étude de cas. Chaque semaine, enregistrez la progression du projet (y compris les liens vers les demandes d'extraction, les problèmes ou les conversations, le cas échéant), ce qui s'est bien passé (ou pas), ce que vous avez appris et les questions qui ont été posées.
Pour en savoir plus, consultez Créer une étude de cas et veillez à suivre notre modèle d'étude de cas. Vous enverrez votre étude de cas sous forme de lien dans le formulaire.
Votre étude de cas sera publiée sur le site de la Google Season of Docs. Gardez cela à l'esprit lorsque vous incluez des informations sur votre projet.
Enquêtes de suivi
Les organisations acceptées doivent participer à au moins trois enquêtes de suivi pour suivre l'évolution des projets de la Google Season of Docs. Les enquêtes de suivi sont essentielles pour comprendre l'impact de la Google Season of Docs.
Formulaires
| Formulaire | Lien | Date limite |
|---|---|---|
| Demande d'organisation |
Les candidatures pour les organisations sont désormais closes. Inscrivez-vous à la liste de diffusion des annonces sur season-of-docs-announce pour vous tenir informé. |
2 avril 2024 à 18h UTC |
| Informations de paiement de l'organisation |
Phase des informations de paiement de l'organisation terminée. Si vous devez modifier les informations de paiement de votre organisation, veuillez contacter les administrateurs de la saison des documents. |
22 mai 2024 à 18h UTC |
| Justificatif de l'embauche d'un rédacteur technique |
Phase de recrutement d'un rédacteur technique terminée. |
22 mai 2024 à 18h UTC |
| Évaluations mensuelles |
La phase d'évaluation mensuelle est terminée. |
Voir la chronologie |
| Envoyer une étude de cas | 10 décembre 2024 à 18h UTC | |
| Évaluation finale du programme | 10 décembre 2024 à 18h UTC | |
| Enquêtes de suivi |
Formulaire disponible pendant la phase d'enquêtes de suivi (1er mai 2025). |
Voir la chronologie |