Phase actuelle:
Le programme Saison 2021 de Docs s'est terminé le 14 décembre 2021. Consultez le calendrier.
Ce guide s'adresse aux administrateurs d'organisations qui souhaitent participer au programme Saison 2021 de Docs ou y participer.
Votre organisation doit-elle participer au programme Saison 2021 des documents Google ?
Utilisez ces questions pour déterminer si votre organisation ou votre projet Open Source doit faire partie de Season of Docs.
Est-ce que votre organisation ou votre projet:
- Pensez-vous qu'une documentation nouvelle ou mise à jour vous aiderait à atteindre un objectif ou à résoudre un problème dans votre projet ou votre communauté ?
- Avez-vous une première compréhension ou une hypothèse sur la façon dont vous mesureriez le succès de votre projet de documentation ?
- Avez-vous des membres de la communauté disposés à aider à recruter, à évaluer et à intégrer un rédacteur technique, et qui serait disponible pour répondre aux questions et fournir d’autres soutiens au cours du projet (6 à 8 mois, y compris la période de candidature) ?
- Avez-vous un membre de la communauté disposé à 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 à soumettre des évaluations mensuelles ainsi que l’évaluation finale et l’étude de cas ? L'administrateur de l'organisation doit également être disposé à répondre à des enquêtes de suivi une fois la saison 2021 de Docs terminée.
Votre organisation doit également répondre aux critères d'éligibilité du programme et être en mesure de créer un compte Open Collective.
Procédure d'inscription des organisations
Phase d'exploration
Bien que les inscriptions pour la saison 2021 de Docs débutent le 9 février 2021, nous recommandons vivement aux entreprises de prendre le temps de suivre la phase d'exploration avant d'envoyer leur candidature.
- Créer une page de proposition de projet. La page de la 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 aux communautés de contribuer et de discuter. Incluez des informations pour les rédacteurs techniques qui souhaitent participer : où doivent-ils poser des questions, exprimer leur intérêt ou en savoir plus sur votre projet ? (Consultez la liste des idées de projets pour obtenir des exemples.)
- Faites connaître la page de votre proposition sur les chaînes de la communauté et ajoutez votre organisation à la liste des organisations intéressées dans le dépôt GitHub Season of Docs. Vous pouvez également partager votre lien sur la chaîne #season-of-docs dans le Slack Docs. La page Promotion et presse inclut des logos et d'autres contenus que vous pouvez utiliser lorsque vous parlez de "Season of Docs".
- Pour chaque idée de documentation, réfléchissez à l'expérience et aux qualifications dont un rédacteur technique devrait avoir besoin pour travailler efficacement avec votre communauté et votre organisation. Quelles compétences votre communauté pourrait-elle développer pour aider un rédacteur technique à développer un produit (par exemple, en utilisant GitHub ou la chaîne d'outils de vos documents) ? (Consultez le guide de collaboration avec des rédacteurs techniques.
- Demander des bénévoles pour répondre aux questions de rédacteurs techniques intéressés.
- Commencez à examiner les déclarations d'intérêt soumises par des rédacteurs techniques intéressés par votre projet.
Phase de candidature
- Choisissez l'idée la plus prometteuse sur la page de la proposition. Chaque organisation ne peut soumettre qu'une seule proposition. Voici quelques éléments à prendre en compte :
- Quelle idée a suscité le plus d'intérêt de la part des rédacteurs techniques ?
- Quelle idée aidera à résoudre le plus grand 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 achevée, mais qui n'affectera pas de manière significative votre projet.
- L'idée nécessite-t-elle la participation de certains membres de votre communauté ? Ont-ils le temps de participer ?
Créez votre proposition à l'aide du modèle de proposition. Assurez-vous de bien comprendre et d'inclure les éléments suivants:
- Le problème que vous souhaitez résoudre
- La portée de la documentation que vous souhaitez améliorer ou créer
- Comment vous allez mesurer le succès de votre documentation
Votre proposition doit également inclure un budget. Les propositions incomplètes ne seront pas prises en compte.
Envoyez le Formulaire de candidature avant le 26 mars 2021 à 18h UTC. Les propositions acceptées seront annoncées le 16 avril 2021.
Développement de projet et création de rapports
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 votre rédacteur technique. Vous devez collaborer avec votre rédacteur technique pour créer un calendrier du travail et des contrôles réguliers.
- Si vous avez reçu plusieurs déclarations d'intérêt de la part de rédacteurs techniques intéressés, faites une annonce publique de votre sélection de rédacteurs techniques ou informez les candidats de votre décision.
Subventionner les paiements
- À partir du 10 juin 2021, Season of Docs déposera 40% des fonds sur le compte Open Collective de chaque organisation après l'embauche d'un rédacteur technique. Nous recommandons aux entreprises de créer un échéancier des paiements avec les rédacteurs techniques en fonction des étapes du projet, y compris un paiement au lancement du projet.
- Les 60% restants seront versés sur les comptes Open Collective des organisations qui terminent et soumettent leurs évaluations finales et leurs études de cas à partir du 14 décembre 2021.
- Pour en savoir plus sur la création d'un compte Open Collective, consultez le guide des paiements.
Création de rapports sur l'état d'avancement du projet
- Les administrateurs de l'organisation doivent remplir les rapports d'état mensuels dans la semaine suivant la réception du lien vers le formulaire de rapport d'état (ce lien sera envoyé par e-mail ; pensez à vérifier votre dossier de spam).
Évaluation finale et étude de cas du projet
Les organisations doivent terminer et envoyer l'évaluation finale du projet et l'étude de cas avant le 30 novembre 2021 à 18h UTC pour recevoir les fonds restants de la subvention.
Évaluation finale
Le formulaire d'évaluation final sera mis à la disposition des administrateurs de l'organisation au moins un mois avant le 30 novembre 2021 à 18h UTC.
Étude de cas
L'étude de cas Season of Docs est le produit livrable principal de la participation de votre organisation à Season of Docs 2021. Tenir un journal hebdomadaire des mises à jour du projet vous aidera à créer votre étude de cas. Pour chaque semaine, enregistrez l'avancement 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 (ou non) bien (ou pas), ce que vous avez appris et les questions qui ont été posées.
Pour en savoir plus, consultez la page Créer une étude de cas et assurez-vous de suivre notre modèle d'étude de cas pour la créer. Vous soumettrez votre étude de cas sous forme de lien dans le formulaire d'évaluation finale.
Votre étude de cas sera publiée sur le site Season of Docs. Veuillez donc en tenir compte lorsque vous incluez des informations sur votre projet.
Nous demandons aux organisations de participer à au moins trois enquêtes de suivi pour nous aider à suivre la réussite des projets Season of Docs dans le temps.
Formulaires
| Forme | Lien | Échéance |
|---|---|---|
| Application de l'organisation | Les candidatures des entreprises sont désormais closes. Rejoignez la liste de diffusion des annonces sur season-of-docs-announce pour rester informé. |
26 mars 2021 à 18h UTC |
| Informations de paiement de l'organisation | 12 mai 2021 à 18h UTC | |
| Preuve du recrutement du rédacteur technique | 17 mai 2021 à 18h UTC | |
| Évaluations mensuelles | Formulaire disponible pendant la phase d'évaluation du projet (5 juin 2024). |
Consultez la chronologie. |
| Évaluation finale du projet et étude de cas | Formulaire disponible lors de la phase finale d'évaluation du projet et d'étude de cas (du 22 novembre 2024 au 10 décembre 2024). |
30 novembre 2021 à 18h UTC |
| Enquêtes de suivi | Formulaire disponible pendant la phase d'enquêtes de suivi (1er mai 2025). |
Consultez la chronologie. |
Informations connexes
- Consultez la chronologie de la saison de Docs.