Phase actuelle:
annonce des résultats dans le calendrier.
Ce guide s'adresse aux administrateurs d'organisations qui souhaitent participer au programme Season of Docs ou y participer.
Votre organisation doit-elle participer au programme Season of Docs ?
Utilisez ces questions pour déterminer si votre organisation ou votre projet Open Source doit participer à 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 compréhension initiale ou une hypothèse sur la façon dont vous pourriez mesurer 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 la candidature, à 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 accepter de répondre à des enquêtes de suivi une fois le programme saisonnier des documents Google Docs terminé.
Votre organisation doit également remplir les critères d'éligibilité du programme. Par exemple, elle doit pouvoir créer un compte Open Collective.
Procédure de candidature des organisations
Phase d'exploration
Bien que les candidatures pour Season of Docs soient ouvertes le 23 février 2022, nous recommandons vivement aux organisations de prendre le temps de suivre la phase d'exploration avant d'envoyer leur candidature.
- Page de création d'une proposition de projet La page de proposition comprend une liste de besoins, d'objectifs ou de problèmes clés, ainsi que les solutions de documentation et les 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 aller 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 Season of Docs. Toutefois, nous vous déconseillons vivement d'utiliser une adresse e-mail personnelle comme adresse e-mail pour contacter votre organisation Open Source. (Consultez la liste d'idées de projets pour voir des exemples.)
- Faites la promotion de la page de votre proposition sur les canaux 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 le lien sur la chaîne #Season-of-docs du site Write The Docs Slack. 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 aider à développer un rédacteur technique (par exemple, en utilisant GitHub ou la chaîne d'outils de vos documents) ? Consultez le guide de collaboration avec les rédacteurs techniques.
- Demander l'intervention de bénévoles pour répondre aux questions de rédacteurs techniques intéressés.
- Commencez à examiner toutes 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 "Proposition". Chaque organisation ne peut soumettre 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 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 pour un projet de documentation plus susceptible d'être achevée, mais qui ne fera pas de différence significative pour votre projet.
- L'idée nécessite-t-elle la participation de membres spécifiques 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 avant le 25 mars 2022 à 18h UTC. Les propositions acceptées seront annoncées le 14 avril 2022.
Développement de projet et création de rapports
Lancement du projet
- Si votre organisation a déjà désigné 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 des travaux 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 concernant votre sélection de rédacteurs techniques ou informez les candidats de votre décision.
Paiements de subventions
- À partir du 9 juin 2022, Season of Docs versera 40% des fonds de la subvention sur le compte Open Collective de chaque organisation après l'embauche d'un rédacteur technique. Nous recommandons aux organisations de créer un échéancier des paiements 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 finalisent et envoient leurs évaluations finales et leurs études de cas à compter du 14 décembre 2022. Veuillez noter que tous les projets réussis, quel que soit leur calendrier d'achèvement (par exemple, un projet de trois mois ou un projet de six mois), commenceront à recevoir le paiement final le 14 décembre 2022.
- Pour en savoir plus sur la création d'un compte Open Collective, consultez le guide des paiements.
Rapports sur l’état d’avancement du projet
- Les administrateurs de l'organisation doivent remplir les rapports d'état mensuels dans la semaine qui suit la réception du lien vers le formulaire de rapport d'état (ce lien sera envoyé par e-mail. Veuillez vérifier votre dossier de spam).
É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 30 novembre 2022 à 18h UTC pour recevoir les fonds restants de la subvention.
Évaluation finale
Le formulaire d'évaluation finale sera mis à la disposition des administrateurs de l'organisation au moins un mois avant le 30 novembre 2022 à 18h UTC.
Étude de cas
L'étude de cas Season of Docs est le produit livrable clé de la participation de votre organisation à Season of Docs. 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), ce qui s'est bien passé (ou pas), les choses que vous avez apprises et les questions qui ont été posées.
Veuillez lire la section Créer une étude de cas pour obtenir des informations supplémentaires et assurez-vous de suivre notre modèle d'étude de cas pour la réaliser. 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. Vous devez 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 au fil du temps.
Formulaires
| Formulaire | Lien | Échéance |
|---|---|---|
| Candidature de l'organisation | Les candidatures des entreprises sont désormais closes. Inscrivez-vous sur la liste de diffusion des annonces sur season-of-docs-announce pour vous tenir informé. |
25 mars 2022 à 18h UTC |
| Informations de paiement de l'organisation | Ce formulaire n'est pas encore disponible. |
12 mai 2022 à 18h UTC |
| Preuve du recrutement du rédacteur technique | Phase de recrutement du rédacteur technique terminée. |
16 mai 2022 à 18h UTC |
| Évaluations mensuelles | La phase d'évaluation mensuelle est terminée. |
Voir la chronologie |
| Évaluation finale du projet et étude de cas | La phase d'évaluation du projet est terminée. |
30 novembre 2022 à 18h UTC |
| Enquêtes de suivi | Formulaire disponible pendant la phase d'enquêtes de suivi (2 mai 2023). |
Voir la chronologie |
Informations connexes
- Consultez la chronologie de la saison dans Docs.