Questions fréquentes (FAQ)

Phase actuelle:
Le programme Season of Docs 2020 s'est terminé le 15 mars 2021. Consultez la chronologie.

Questions d'ordre général

Season of Docs est-il un programme de recrutement ?

Non. Si vous souhaitez travailler pour Google, veuillez consulter le site Web de recrutement et d'offres d'emploi de Google.

Season of Docs est-il considéré comme un stage, un emploi ou toute autre forme d'emploi ?

Non. La saison de Docs est une activité que le rédacteur technique réalise en tant que rédacteur technique indépendant et pour lequel il est rémunéré. Les rédacteurs techniques peuvent choisir de ne pas recevoir l'aide.

Pourquoi participer à Season of Docs ?

L'objectif de Season of Docs est de favoriser la collaboration entre les organisations Open Source et les rédacteurs techniques. Nous pensons que ce programme permettra:

  • Donnez aux rédacteurs techniques l'occasion d'acquérir de l'expérience pour contribuer à des projets Open Source et d'en apprendre davantage sur le code Open Source.
  • Donnez aux projets Open Source la possibilité d'engager la communauté de la rédaction technique, et donc d'améliorer leurs documents Open Source.
  • Sensibilisez les utilisateurs aux documents Open Source et à la rédaction technique.

Avantages pour les organisations Open Source:

  • Expérience de travail avec un rédacteur technique
  • Amélioration des documents
  • Le potentiel de collaboration continue avec les rédacteurs techniques après la fin de Season of Docs
  • Amélioration des processus de documentation de vos projets.
  • Meilleure notoriété des documents Open Source au sein de la communauté de la rédaction technique

Avantages pour les rédacteurs techniques:

  • Expérience en matière de contribution à un projet Open Source
  • Expérience de travail avec le code et les documents destinés aux développeurs
  • Le crédit et la reconnaissance pour le travail accompli.
  • Quelque chose à ajouter à votre CV.
  • Le potentiel de collaboration continue avec le projet Open Source après la fin de la saison de Docs
  • Meilleure sensibilisation des communautés Open Source à la valeur que les rédacteurs techniques peuvent apporter

Quels types de projets les rédacteurs techniques peuvent-ils aborder ?

Voici quelques idées :

  • Créer un site de documentation sur une plate-forme qui sera choisie par le rédacteur technique et le mentor Open Source, et publier un ensemble initial de documents de base sur le site. Voici quelques exemples de plates-formes:

  • Refactorisez la documentation existante du projet Open Source pour offrir une expérience utilisateur améliorée ou une architecture des informations plus accessible.

  • Rédiger une présentation conceptuelle d'un produit ou d'une fonctionnalité, ou en présenter un. Souvent, une équipe crée sa documentation technique de bas en haut, ce qui signifie qu'il y a beaucoup de détails, mais qu'il est difficile de comprendre le produit dans son ensemble. Un rédacteur technique peut résoudre ce problème.

  • Créez un tutoriel pour un cas d'utilisation important.

  • Créez un ensemble de guides d'utilisation dédiés à des tâches spécifiques.

  • Créez un guide du contributeur contenant des informations de base sur les premiers pas en tant que contributeur du projet Open Source, ainsi que les règles concernant les contrats de licence, les processus de demande d'extraction et de révision, la création du projet, etc.

Une vidéo peut-elle faire l'objet d'un projet pour Season of Docs ?

Oui. C'est à l'organisation Open Source de publier les idées de projet et de choisir une proposition de projet soumise par un rédacteur technique. Si une vidéo répond aux exigences de l'organisation Open Source, vous pouvez l'envoyer en tant que projet Season of Docs, à condition qu'il s'agisse d'une vidéo d'instructions techniques. Assurez-vous que les exigences concernant la vidéo sont bien définies et gardez à l'esprit que la production d'une vidéo de haute qualité demande du temps et des ressources.

Les organisations de mentorat sont-elles tenues d'utiliser les documents produits par les rédacteurs techniques ?

Non. Nous espérons que l'ensemble de la documentation et du code issus de ce programme trouvera votre bonheur, mais nous n'obligeons pas les organisations à utiliser les documents ou le code des rédacteurs techniques.

Où se produit la saison de Google Docs ?

Season of Docs s'exécute entièrement en ligne. Il n'est pas nécessaire de voyager dans le cadre du programme.

Comment puis-je me tenir informé au sujet de Season of Docs ?

Consultez la liste de diffusion des annonces à l'adresse season-of-docs-announce pour connaître les dernières mises à jour et annonces concernant Season of Docs. Rejoignez le groupe pour recevoir les mises à jour par e-mail.

Comment faire connaître la saison de Docs ?

Vous pouvez tweeter à propos du programme, rédiger des articles de blog, publier des vidéos, ou organiser une rencontre ou une session d'information dans votre région. Nous mettons à votre disposition des exemples de contenu et de ressources que vous pouvez utiliser pour distribuer votre communauté à votre communauté (organisation, groupe de rédacteurs et autres contacts).

Comment organiser ou organiser une session d'information ou une rencontre Season of Docs ?

Vous pouvez planifier une rencontre à l'endroit et au moment qui vous conviennent. Veuillez consulter les règles du programme et utiliser l'exemple de contenu.

Puis-je participer à Season of Docs en tant que mentor et rédacteur technique ?

Non. Nous voulons nous assurer que chaque projet et rédacteur technique reçoit suffisamment d'attention, ce qui peut nuire à l'expérience des personnes concernées. Veuillez indiquer si la participation en tant que mentor ou rédacteur technique est plus intéressante pour vous, et prévoyez d'envoyer votre candidature en conséquence.

Pouvez-vous partager des statistiques sur la saison de Docs 2019 ?

Oui, les résultats de la saison 2019 du programme Docs sont disponibles sur cette page.

Vais-je recevoir un t-shirt Season of Docs ?

Oui ! Les rédacteurs techniques et les mentors qui participent aux projets menés avec succès recevront un T-shirt Season of Docs.

Quand mon t-shirt arrivera-t-il ?

Selon nos estimations, vous recevrez votre tee-shirt début 2021. Google a fait appel à un fournisseur pour fabriquer les T-shirts et gérer la logistique liée à leur livraison dans le monde entier. Les administrateurs du programme Google vous enverront un code d'accès unique par e-mail pour sélectionner le style/la taille de votre t-shirt et saisir vos informations de livraison peu de temps après l'annonce des résultats du projet de longue durée. La production et l'expédition des t-shirts prennent généralement quelques semaines.

Que dois-je faire si j'ai d'autres questions ?

Consultez le guide pour les rédacteurs techniques, le guide pour les mentors et le guide pour les administrateurs de l'organisation.

Si vous n'avez toujours pas de réponse après avoir lu toute la documentation, n'hésitez pas à discuter de vos questions avec la communauté Season of Docs sur Slack ou sur la liste de discussion. Consultez les informations sur les canaux de discussion et découvrez comment nous contacter.

Pour les rédacteurs techniques

Quand les rédacteurs techniques peuvent-ils postuler pour Season of Docs ?

La phase de candidature de rédacteur technique s'étend du 9 juin 2020 au 9 juillet 2020. Consultez le calendrier du programme et le guide du rédacteur technique.

Quels outils et cadres de documentation dois-je connaître pour participer à Season of Docs ?

Les outils et frameworks de documentation que vous utiliserez dépendent de l'organisation avec laquelle vous souhaitez travailler. L'objectif de Season of Docs est d'aider les rédacteurs techniques à se familiariser avec les outils et frameworks impliqués dans la documentation des produits Open Source grâce aux projets Open Source. Pour cette raison, il n'est généralement pas nécessaire de connaître précisément des plates-formes de documentation spécifiques avant de commencer votre projet Season of Docs.

Cela dit, la plupart des organisations Open Source utilisent une certaine saveur de Markdown ou d'un autre langage de balisage pour leur documentation. Nous vous recommandons d'identifier le langage utilisé par l'organisation que vous avez choisie et de vous familiariser avec la syntaxe. Markdown est un bon début, car les fichiers README de GitHub utilisent un type de Markdown. Consultez le guide GitHub sur Markdown.

Déterminez si l'organisation que vous avez choisie héberge déjà sa documentation sur un site Web et, le cas échéant, quelle plate-forme elle utilise. La plate-forme peut être un générateur de site statique tel que Jekyll, Sphinx ou Hugo, ou l'organisation peut héberger ses documents sur Lire la documentation ou sur des pages GitHub. Une fois que vous avez découvert la plate-forme utilisée par l'organisation, explorez et testez le langage et le framework pertinents. Cela vous aide à démarrer rapidement votre projet Open Source et vous permet de fournir des conseils avisés pour le projet Open Source de votre choix.

Quel(s) langage(s) de programmation dois-je connaître pour participer à Season of Docs ?

Selon la nature de votre projet de documentation, vous devrez peut-être connaître un langage de programmation. Tenez-en compte lorsque vous choisissez et proposez un projet de documentation, et consultez l'organisation Open Source sur le niveau de connaissance requis.

Puis-je soumettre plusieurs propositions de projets ?

Oui, mais une seule proposition de projet par rédacteur technique sera acceptée. Consultez le guide pour créer une application.

Les rédacteurs techniques travaillant déjà sur un projet Open Source peuvent-ils continuer à y travailler dans le cadre de Season of Docs ?

Oui, mais vous devez noter votre relation antérieure avec le projet dans votre proposition.

Un groupe peut-il soumettre une proposition à plusieurs sur un même projet ?

Non, seule une personne peut travailler sur un projet donné.

Puis-je contacter directement les organismes de mentorat avant de soumettre une proposition pour Season of Docs ?

Oui, vous pouvez communiquer directement avec l'organisation Open Source avec laquelle vous souhaitez travailler, avant d'envoyer votre candidature pour Season of Docs. Les mentors Open Source peuvent vous aider à affiner votre idée de projet.

Quels sont les critères d'éligibilité pour participer au programme ?

  • Vous devez avoir au moins 18 ans au moment de vous inscrire.
  • Vous devez avoir le droit de travailler dans le pays où vous résidez pendant le programme.
  • Vous devez résider dans un pays qui n'est actuellement pas sous embargo des États-Unis. Consultez les Règles du programme et les Informations sur les pays et programmes de sanctions émises par le Trésor américain.

Allez-vous faire une exception aux critères d'éligibilité pour moi ?

Non. Nous ne pouvons pas faire d'exception si vous ne remplissez pas les critères d'éligibilité, quel que soit votre niveau de talent ou d'intérêt. Faire une exception ne serait pas juste pour les autres rédacteurs techniques qui demandent à participer à Season of Docs.

Quels formulaires devrai-je fournir ?

Les participants acceptés devront fournir les formulaires fiscaux appropriés.

Ai-je besoin d'une expérience ou d'une formation préalable en tant que rédacteur technique ?

Une expérience ou une formation technique en rédaction est préférable, mais pas indispensable. Lorsque vous soumettez une proposition de projet, vous pouvez décrire votre expérience et/ou votre formation en rédaction technique. Vous devriez être en mesure de fournir des preuves de votre intérêt pour la documentation technique ou Open Source, y compris des exemples de documentation que vous avez rédigés. Le programme Season of Docs vise à collaborer avec des rédacteurs techniques expérimentés ou en formation avec des mentors Open Source, afin que chacun puisse apprendre des autres. L'organisation Open Source recherchera des rédacteurs techniques ayant le niveau d'expérience requis pour s'assurer de la réussite de leurs projets Season of Docs.

Serai-je rémunéré pour ma participation à Season of Docs ?

Oui. Google versera une rémunération aux rédacteurs techniques qui terminent le programme avec succès. Vous pouvez choisir de ne pas recevoir cette aide. Consultez les détails du rédacteur technique.

Serai-je payé même si l'organisation n'utilise pas ma documentation ou mon code ?

Oui, à condition que votre projet passe l'évaluation finale par le mentor Open Source. Le fait que le projet Open Source utilise ou non la documentation ou le code produits n'a aucune incidence sur le paiement de la rémunération du rédacteur technique.

À quoi ressemble une bonne proposition de rédacteur technique ?

Les meilleures propositions sont celles de rédacteurs techniques qui prennent le temps d'interagir et de discuter de leurs idées avec l'organisation Open Source de leur choix avant de soumettre leur candidature Season of Docs. Consultez le guide pour créer une application.

Combien de temps prend la participation à Season of Docs ?

Le temps que vous passez dépend de la nature du projet auquel vous vous êtes mis d'accord avec votre organisation mentor. L'exigence de nombre d'heures est délibérément flexible, afin de permettre différents types de projets et styles de travail. En moyenne, les rédacteurs techniques consacrent 20 à 30 heures par semaine.

Avant de soumettre votre proposition de projet, vous devez évaluer le projet et discuter d'une estimation de temps avec l'organisation Open Source. S'il vous est difficile de consacrer le temps convenu en raison d'autres engagements, il existe une option permettant de terminer le projet dans une période plus longue, tout en recevant le versement des bénéfices et la reconnaissance du travail effectué. Lorsque vous envoyez votre application Season of Docs, spécifiez l'option pour un projet de longue durée.

J'étudie la communication technique, mais je n'ai pas encore d'expérience professionnelle. Puis-je quand même participer ?

Oui. Lorsque vous soumettez votre proposition de projet, indiquez vos cours universitaires dans la section "Expérience professionnelle".

Je suis un étudiant accepté aux États-Unis avec un visa F1. Comment puis-je obtenir l'autorisation de participer ?

Pour en savoir plus, contactez le service des études internationales de votre établissement. Google ne peut vous fournir aucune autorisation CPT ou OPT.

Tous les participants acceptés recevront un e-mail de confirmation. Nous ne proposons pas de lettres personnalisées.

Comment Season of Docs utilise-t-il les informations de mon formulaire d'inscription ?

Les administrateurs du programme Google transmettent certaines des informations de votre application aux administrateurs de l'organisation Open Source de votre choix, afin que celle-ci puisse évaluer votre proposition de projet.

Si votre projet est accepté dans le programme, Season of Docs publie les détails du projet sur le site Web.

Consultez la description de l'utilisation des données dans le guide du formulaire de demande de rédacteur technique.

Puis-je participer en tant que rédactrice technique à Season of Docs et en tant qu'étudiante à Google Summer of Code ?

Bien que cela ne soit pas contraire au règlement pour le moment, nous vous recommandons vivement que les étudiants qui acceptent Google Summer of Code ne souhaitent pas postuler pour des créneaux de rédacteur technique pour Season of Docs. Les élèves devraient se concentrer sur le travail Google Summer of Code au lieu de postuler pour Season of Docs.

Pour les mentors et les administrateurs d'organisations Open Source

Je souhaite en savoir plus sur ma participation en tant que mentor dans Season of Docs. Où trouver des informations supplémentaires ?

Consultez le guide du mentor et les règles du programme pour savoir comment devenir mentor pour les fêtes.

Quels sont les critères d'éligibilité d'une organisation de mentorat ?

Pour pouvoir participer en tant qu'organisation de mentorat, vous devez être un groupe exécutant un projet logiciel actif sans frais/Open Source, tel que BRL-CAD. Le projet ne doit pas nécessairement être une entité constituée légalement. Les organisations de mentorat doivent avoir déjà produit et publié un logiciel sous une licence Open Source Initiative, et compter au moins deux contributeurs en tant qu'administrateurs et/ou mentors de l'organisation pour l'ensemble du programme Season of Docs afin de participer au programme.

Consultez également les critères d'éligibilité décrits dans les Règles du programme et dans la section Programmes de sanctions et informations sur les pays du Trésor des États-Unis.

Le terme "organisation" équivaut-il à un projet Open Source ?

Une organisation peut avoir un ou plusieurs projets Open Source. Certaines organisations, telles que les fondations, peuvent avoir plusieurs sous-organisations comprenant chacune un ou plusieurs projets Open Source. Si votre organisation possède des sous-organisations indépendantes, veuillez l'indiquer clairement dans votre demande d'inscription. Par exemple, le langage de programmation "Foo" peut s'appliquer à la documentation du langage dans son ensemble, ainsi qu'à tous les plug-ins, bibliothèques ou modules utilisés avec le langage.

Les organisations reçoivent-elles de l'argent pour leur participation à Season of Docs ?

Les organisations en règle reçoivent une prime pour chaque rédacteur technique accepté à la fin du programme. que le projet du rédacteur technique soit réussi ou non. Les organisations sont libres d'utiliser ces fonds comme elles le souhaitent.

Comment les administrateurs du programme Google allouent-ils les emplacements pour les projets d'écriture technique ?

La saison 2020 de Season of Docs est limitée à un maximum de 50 projets d'écriture technique au total.

En règle générale, nous prévoyons d'accepter un maximum de deux projets par organisation, afin d'éviter d'avoir un trop grand nombre de projets acceptés. Toutefois, si le processus de sélection libre ne remplit pas tous les emplacements, les administrateurs du programme Google peuvent allouer des emplacements supplémentaires à certaines organisations.

Lorsque vous envoyez votre sélection de projets d'écriture technique, vous pouvez donc sélectionner plus de deux projets. Assurez-vous de lister vos sélections par ordre de priorité, en commençant par la priorité la plus élevée.

Dans vos communications avec les rédacteurs techniques, vous devez indiquer clairement que le projet n'est pas accepté tant que les administrateurs du programme Google n'ont pas publié la liste des projets acceptés sur le site Web du programme.

La candidature d'une organisation peut-elle être examinée avant la date limite d'envoi ?

Nous ne sommes malheureusement pas en mesure de vous fournir des commentaires sur la candidature de l'organisation.

Comment les organisations doivent-elles étudier leurs idées de projet ?

De nombreux projets changeront de portée au fur et à mesure de leur progression. En tant que mentors, vous devez être au courant de tout changement apporté aux projets et essayer de minimiser le glissement de la portée et de réduire la portée, le cas échéant. Lorsque vous développez des idées de projet, essayez de trouver les plus petits projets qui apporteront de la valeur à l’organisation (mais qui peuvent être étendus si le temps le permet). Plus petit, mieux c'est. Lors de l'évaluation des propositions des rédacteurs techniques, nous recommandons de privilégier les propositions plus petites et plus détaillées aux projets plus importants et moins spécifiés. Si votre projet nécessite une grande expertise dans le domaine, essayez d'inclure des projets qui pourraient être réalisés par une personne sans cette expérience.

Un audit de la documentation est-il un projet raisonnable pour Season of Docs ?

Un audit de la documentation est un excellent projet pour Season of Docs. Faites attention à la quantité de documentation dont vous disposez déjà. Si vous en avez beaucoup, vous devrez peut-être en réduire le champ d'application (par exemple, simplement vérifier le contenu du tutoriel). Si vous disposez de peu ou pas de documentation, vous pouvez inclure la création de la documentation manquante de priorité la plus élevée dans le cadre de votre projet.

Des modèles de documentation sont-ils disponibles pour les entreprises et les rédacteurs techniques ?

Le projet Good Docs travaille actuellement à la création de modèles de documentation minimum viable pour l'Open Source.

Puis-je participer à Season of Docs en tant qu'administrateur et mentor de l'organisation ?

Oui. L’administrateur de l’organisation peut également être un mentor. Vous n’avez pas besoin de remplir un formulaire de mentor distinct. Lorsque vous remplissez le formulaire de demande pour l'organisation ou celui de l'administrateur alternatif, vous devez utiliser l'option de ce formulaire pour indiquer que vous agissez également en tant que mentor.

Puis-je participer en tant qu'administrateur d'organisation ou mentor à la fois à Season of Docs et à Google Summer of Code ?

Oui. Season of Docs et Google Summer of Code sont des programmes distincts. Si vous avez la bande passante requise pour participer aux deux programmes, ce n'est pas un problème.

Puis-je participer en tant qu'administrateur d'organisation ou mentor à la fois à Season of Docs et à Google Code-in ?

Oui. Season de Docs et Google Code-in sont des programmes distincts. Si vous avez la bande passante requise pour participer aux deux programmes, ce n'est pas un problème.

Données archivées

Comment supprimer mes informations de l'archive des saisons de Google Docs ?

Contactez-nous pour demander la suppression de vos informations.