Phase actuelle:
Le programme Season of Docs 2020 s'est terminé le 15 mars 2021. Consultez la chronologie.
Cette page contient le guide destiné aux rédacteurs techniques qui participent à Season of Docs.
Introduction
Bienvenue dans Season of Docs ! Ce guide vous en dit un peu plus sur votre participation à Season of Docs et vous aide pour les activités à effectuer à chaque phase du programme.
Éligibilité à Season of Docs
Pour participer à Season of Docs en tant que rédacteur technique, vous devez:
- être âgé(e) d'au moins 18 ans au moment de l'enregistrement.
- Vous êtes capable de démontrer votre expérience de la rédaction technique en soumettant des descriptions de poste et des exemples de travail.
- être autorisé à travailler dans son pays de résidence pendant la durée du programme ;
- résider dans un pays qui n'est pas sous embargo des États-Unis ; Consultez l'article Programme de sanctions et informations sur les pays du Trésor américain.
Consultez l'intégralité des conditions applicables aux rédacteurs techniques.
Vos mentors Open Source
Les mentors Season of Docs ne sont pas nécessairement des rédacteurs techniques et peuvent avoir peu d'expérience en communication technique. Ils sont des membres de l'organisation Open Source qui connaissent l'importance d'une bonne documentation et qui sont expérimentés dans les processus et outils Open Source.
La relation entre vous et vos mentors est une collaboration. Vous apportez votre expérience et vos compétences en matière de documentation au sein d'une organisation Open Source. Vos mentors partagent leurs connaissances sur l'Open Source et le code. Ensemble, vous pouvez développer une documentation technique et améliorer les processus du projet Open Source.
Annonce du programme et phases de candidature de l'organisation
La date de l'annonce pour Season of Docs est le 23 mars 2020. Les organisations Open Source intéressées peuvent demander à participer à Season of Docs entre le 13 avril 2020 et le 4 mai 2020. Les administrateurs du programme Google publient la liste des organisations ayant réussi le 11 mai 2020.
Entre l'annonce du programme et la publication des organisations Open Source participantes, vous devez être attentif aux nouvelles. Vous pouvez retourner sur ce site Web et consulter des articles de blog ou d'autres actualités sur le Web. Certaines organisations Open Source peuvent partager leurs idées même pendant la phase d'application de l'organisation.
Nous vous invitons également à parler de Season of Docs et à expliquer pourquoi ce programme vous intéresse. Consultez les supports promotionnels pour trouver des images et des idées.
Phase d'exploration du rédacteur technique
La phase d'exploration du rédacteur technique s'étend du 11 mai au 8 juin 2020. Au cours de cette période, vous pouvez examiner la liste des organisations participantes et leurs idées de projet. Cet appel est ouvert aux rédacteurs techniques : vous n'avez pas besoin de l'approbation de Season of Docs pour commencer. Gardez toutefois à l'esprit les critères d'éligibilité ci-dessus.
Lorsque vous trouvez un ou plusieurs projets qui vous intéressent, vous devez contacter directement l'organisation Open Source concernée pour discuter de vos idées.
| Vos tâches en tant que rédacteur technique au cours de cette phase | |
|---|---|
|
Explorez la liste des organisations Open Source participantes et leurs idées de projet. |
Examinez la liste pour trouver l'organisation Open Source avec laquelle vous souhaitez travailler. Consultez les projets de rédaction technique proposés par les organisations et choisissez ceux qui vous conviennent. Vous pouvez postuler pour plusieurs organisations. À ce stade de Season of Docs, il est recommandé d'explorer plusieurs options. Le processus de sélection final n'accepte qu'un seul projet par rédacteur technique. |
|
Discuter d'idées de projets avec des organisations Open Source |
Vous pouvez discuter d'idées de projet avec l'une des organisations participantes. Pour nous contacter, utilisez l'adresse e-mail de l'organisation indiquée dans la liste des organisations participantes. Les premières discussions vous aident à élaborer une bonne proposition de projet à soumettre aux administrateurs du programme Google lors de la phase de candidature de la rédaction technique. Les idées initiales de projet peuvent provenir de la liste d'idées proposée par l'organisation. Vous pouvez également proposer vos propres idées. |
Phase de candidature du rédacteur technique
La phase de candidature de rédacteur technique s'étend du 9 juin 2020 au 9 juillet 2020. Pendant cette période, vous pouvez demander à participer à Season of Docs. Les administrateurs du programme Google transfèrent les informations pertinentes de votre application à l'organisation Open Source de votre choix. Les administrateurs et les mentors de l'organisation Open Source sélectionnent ensuite les projets qu'ils souhaitent parrainer.
| Vos tâches en tant que rédacteur technique au cours de cette phase | |
|---|---|
|
Envoyez votre candidature pour participer à Season of Docs. |
Envoyez votre candidature pour Season of Docs avant le 9 juillet 2020. Les demandes de rédacteur technique pour la saison 2020 de Docs sont closes. Inscrivez-vous sur la liste de diffusion des annonces sur season-of-docs-announce pour vous tenir informé. |
Phase d'association avec une communauté
La phase de cohésion de la communauté se déroule du 17 août au 13 septembre 2020. Au cours de cette période, les mentors Open Source vous aident à vous familiariser avec le projet et la communauté Open Source.
| Vos tâches en tant que rédacteur technique au cours de cette phase | |
|---|---|
|
Mettez en place des canaux de communication. |
Prenez contact avec votre ou vos mentors au sein de l'organisation Open Source avec laquelle vous avez choisi de travailler. Assurez-vous de disposer d'un moyen fiable de communiquer directement avec votre mentor et avec les administrateurs de l'organisation. Ces derniers sont les membres de l'organisation Open Source qui agissent en tant que contact principal pour la saison des documents Docs dans leur organisation. Responsabilités de vos mentors Guide des mentors pour collaborer avec des rédacteurs techniques |
|
Impliquez-vous dans le projet et la communauté Open Source. |
Posez des questions à votre mentor sur les outils et les processus utilisés par l'organisation Open Source. Présentez-vous sur les listes de diffusion, le chat, le canal Slack et tout autre canal de communication partagé de la communauté Open Source. |
|
Comprenez le produit dans son ensemble. |
Demandez à votre mentor d'expliquer le produit (surtout de manière conceptuelle) que vous allez bientôt documenter. Discutez en détail de l'audience de la documentation. |
|
Définissez des objectifs et des attentes. |
Travaillez avec votre mentor pour affiner les objectifs de votre projet de rédaction technique et définir les attentes des deux parties. La définition de ces objectifs et de ces attentes dès maintenant est un bon moyen d'assurer la réussite de votre projet. |
Phase de développement du document
La phase de développement du document s'étend du 14 septembre 2020 au 30 novembre 2020. (La date de fin est différente pour les projets de longue durée.) Au cours de cette période, vous travaillez sur votre projet en consultation étroite avec vos mentors.
| Vos tâches en tant que rédacteur technique au cours de cette phase | |
|---|---|
|
Travaillez avec votre mentor pour mener à bien votre projet. |
Travailler en étroite collaboration avec votre mentor pour mener à bien votre projet. Suivez les procédures de la communauté Open Source pour demander l'examen de la documentation obtenue et envoyer les mises à jour au dépôt Open Source. Par exemple, les projets Open Source hébergés sur GitHub ajoutent ou mettent à jour des fichiers en créant une demande d'extraction pour examen et envoi. |
|
Faites part de vos préoccupations à l'administrateur de l'organisation. |
Si vous avez des préoccupations concernant la communication avec vos mentors ou si vous rencontrez d'autres problèmes susceptibles d'affecter la réussite de votre projet, contactez l'administrateur de l'organisation Open Source. |
|
répondre aux enquêtes des administrateurs du programme Google ; |
Les administrateurs du programme Google peuvent envoyer une enquête en cours de projet pour évaluer les progrès accomplis. Répondez à l'enquête et envoyez vos réponses aux administrateurs du programme Google, comme indiqué dans le document de l'enquête. |
Phase de finalisation et d’évaluation du projet
La phase de finalisation du projet dure du 30 novembre au 5 décembre 2020 et la phase d'évaluation du 3 au 10 décembre 2020. (Les dates sont différentes pour les projets de longue durée.) Au cours de la période de finalisation du projet, vous soumettez votre rapport de projet, également appelé produits de travail finaux. Au cours de la phase d'évaluation, vous soumettez votre évaluation de votre ou vos mentors et de votre expérience en tant que participant à Season of Docs.
| Vos tâches en tant que rédacteur technique au cours de cette phase | |
|---|---|
|
Rédigez votre rapport de projet. |
Rédigez votre rapport de projet (parfois appelé "produit de votre entreprise"). Le rapport de projet comprend une description du travail que vous avez effectué au cours de la saison des documents et tout lien pertinent. La phase de finalisation du projet de longue durée est terminée. |
|
Demandez à votre mentor d’examiner le rapport de votre projet. |
Votre mentor peut avoir des informations précieuses sur la façon de décrire vos réussites. Il est également utile de parvenir à une compréhension commune de l'état du projet à ce stade, avant que votre mentor ne marque le projet comme terminé ou non. |
|
Finalisez votre rapport de projet. |
Finalisez le rapport de votre projet d'ici le 8 mars 2021 à 18h UTC. Le formulaire est modifiable, mais vous devez envoyer la version finale avant la date indiquée. La phase de finalisation du projet de longue durée est terminée. |
|
Rédigez et soumettez votre évaluation de votre mentor et votre expérience de Season of Docs. |
Complétez et envoyez votre évaluation d'ici le 12 mars 2021 à 18h UTC. Évaluations par des rédacteurs techniques La phase d'évaluation du projet de longue durée est terminée. |
Projets de longue durée
Pour les projets de rédaction technique de longueur standard dans Season of Docs, la phase de développement du document s'étend du 14 septembre 2020 au 30 novembre 2020. Cependant, certains rédacteurs techniques peuvent postuler à un projet de longue durée en consultation avec l'organisation Open Source. Pour un projet de longue durée, la phase de développement du document s'étend du 14 septembre 2020 au 1er mars 2021.
La période de finalisation et d'évaluation des projets de longue durée s'étend du 1er au 8 mars 2021.
Vos tâches et responsabilités sont les mêmes que celles décrites sur cette page pour les projets de rédaction technique de longueur standard, si ce n'est que les dates de finalisation et d'évaluation du projet sont postérieures à la date actuelle.
Informations connexes
- Consultez la chronologie de la saison dans Docs.
- Pour en savoir plus sur votre relation avec l'organisation Open Source que vous avez choisie, consultez la page Responsabilités de l'administrateur et du mentorat de l'organisation ainsi que les consignes sur la collaboration avec un rédacteur technique.