Questions fréquentes (FAQ)

Phase actuelle:
annonce des résultats dans le calendrier.

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.

En quoi le programme actuel diffère-t-il de Season of Docs 2019 et 2020 ?

Le programme Season of Docs actuel présente des modifications importantes par rapport aux années précédentes, y compris:

  • Les rédacteurs techniques ne postulent plus via Google pour être mis en relation avec des entreprises.
  • Les organisations soumettent des propositions de projet dans le cadre de leur candidature, y compris un budget et des métriques proposées.
  • Les organisations acceptées reçoivent des subventions qu'elles utilisent pour payer les rédacteurs techniques.
  • Envoi d'évaluations finales et d'études de cas par les organisations

Pourquoi Season of Docs a-t-il apporté ces modifications ?

Google s'est donné pour mission d'organiser les informations à l'échelle mondiale dans le but de les rendre accessibles et utiles à tous. En recentrant Season of Docs sur les pratiques de documentation efficaces dans l'Open Source, nous espérons avoir un impact plus important à long terme.

Notre organisation souhaite participer à Season of Docs, mais nous ne savons pas par où commencer.

Consultez notre liste complète d'idées de projets ! Vous pouvez également contacter la communauté de rédacteurs techniques (essayez la chaîne #Season-of-docs dans la section Écrire le Slack Docs ou sur vos réseaux sociaux pour demander de l'aide ou des propositions).

Quels types de projets les organisations peuvent-elles proposer ?

Voici quelques idées :

  • Créer un site de documentation sur une plate-forme qui sera décidée par le rédacteur technique et l'organisation 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. 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é nécessite beaucoup de temps et de ressources.

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 à la 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 ?

Season of Docs comporte un dépôt GitHub avec un modèle et une checklist pour effectuer des audits de documentation. Nous espérons ajouter d'autres modèles au fur et à mesure de leur création.

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

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

Non. Il peut arriver que les projets ne se déroulent pas comme prévu ou que les exigences changent. Nous n'obligeons pas les organisations à utiliser la documentation ou les autres supports produits, mais nous nous attendons à ce que l'évaluation finale et l'étude de cas incluent une discussion sur les raisons pour lesquelles la documentation n'a pas été utilisée et sur la façon dont le projet a pris la décision de ne pas utiliser la documentation ni d'autres supports.

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.

Puis-je ajouter la chronologie des saisons de Google Docs à mon agenda ?

Oui, vous pouvez l'ajouter via ce lien.

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.

Pouvez-vous partager des statistiques sur les saisons de Docs 2019 et 2020 ?

Oui, les résultats de la saison 2019 du programme Google Docs pour le programme 2019 sont disponibles sur cette page et ceux du programme 2020 sur cette page.

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

Non, en raison de contraintes d'expédition internationales, nous ne pourrons plus fournir de T-shirts aux participants qui ont mené à bien leur projet Season of Docs.

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

Consultez le guide pour les administrateurs de l'organisation et le guide du rédacteur technique.

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

Comment devenir mentor pour Season of Docs ?

Season of Docs n'a pas de rôle de mentor officiel. Les organisations doivent spécifier comment les rédacteurs techniques seront intégrés et soutenus, ainsi que la manière dont leurs contributions à la documentation seront examinées et approuvées dans le cadre de leur candidature. Si vous souhaitez parrainer des rédacteurs techniques dans le cadre de Season of Docs, nous vous encourageons à faire du bénévolat avec les administrateurs de votre organisation.

La saison de Docs est-elle semblable à Google Summer of Code ?

Non. Season of Docs s'adresse aux personnes ayant une certaine expérience de la rédaction technique. Il n'est pas conçu comme un programme de mentorat comme Google Summer of Code.

Pour les rédacteurs techniques

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

Season of Docs ne dispose pas d'une application officielle de rédacteur technique. Pour participer à Season of Docs en tant que rédacteur technique, contactez directement les organisations Open Source en suivant les instructions de leur page de programme Season of Docs. Vous pouvez également indiquer votre intérêt en vous ajoutant à l'annuaire des rédacteurs techniques Season of Docs. Pour en savoir plus, consultez 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 les 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 identifié 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 aux projets 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.

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 l'entreprise doit noter la relation précédente ou continue du rédacteur technique avec le projet dans sa proposition.

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

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 envoyez une déclaration d'intérêt à une organisation, vous pouvez décrire votre expérience et/ou votre formation en rédaction technique. Vous devez ê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. L'organisation Open Source recherchera des rédacteurs techniques ayant le niveau d'expérience dont elle a besoin pour s'assurer de la réussite de ses projets Season of Docs.

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

Oui. Google accordera des subventions aux organisations acceptées pour qu'elles emploient des rédacteurs techniques.

À quoi ressemble une bonne déclaration d'intérêt d'un rédacteur technique ?

Les meilleures déclarations d'intérêt sont celles de rédacteurs techniques qui prennent le temps d'interagir avec l'organisation Open Source de leur choix et d'en discuter avec eux avant d'envoyer leurs déclarations. Consultez le guide pour créer une déclaration d'intérêt.

Combien de temps prend la participation à Season of Docs ?

La taille des projets varie, mais nécessite entre 5 et 30 heures par semaine pendant le programme. Cependant, le temps consacré dépend de la nature du projet sur lequel vous vous êtes mis d'accord avec votre organisation. Avant de vous engager, vous devez évaluer le projet et discuter d'une estimation de temps avec l'organisation Open Source.

Puis-je envoyer une demande d'inscription en tant qu'organisation afin de créer des documents pour un projet Open Source en tant que particulier ? J'aimerais créer une série d'articles de blog, de vidéos ou d'autres documents sur la façon d'utiliser un projet ou un outil Open Source, mais je n'y participe pas ou y contribue.

Non, vous ne devez soumettre une proposition que si vous pouvez recevoir des fonds au nom du projet Open Source. Nous vous encourageons à contacter les responsables du projet et à collaborer sur une proposition de candidature.

Je suis étudiant. Suis-je éligible pour participer à la saison des documents Google ? Est-ce que Season of Docs m'apprendra le métier de rédacteur technique ?

Les étudiants peuvent travailler dans les organisations acceptées, mais Season of Docs n'est pas destiné à enseigner des compétences en rédaction technique. Les rédacteurs techniques participants doivent posséder des compétences professionnelles de rédaction technique ou une expérience pertinente équivalente. Les élèves qui souhaitent participer doivent mettre en avant leur expérience pertinente en matière d'écriture et d'édition lorsqu'ils contactent des organisations et des projets intéressés.

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 aux règles pour le moment, nous recommandons vivement que les élèves acceptés dans Google Summer of Code ne postulent pas pour le poste de rédacteur technique Season of Docs. Les élèves doivent se concentrer sur le travail Google Summer of Code plutôt que sur les candidatures.

De plus, Season of Docs n'est pas destiné aux débutants, mais aux personnes possédant déjà de solides compétences et une expérience de rédaction technique. Les rédacteurs techniques dans Season of Docs ne sont pas mentorés. Ils doivent plutôt être auto-organisés et motivés pour définir leur plan d'attaque du projet de l'organisation avec un minimum de conseils de la part des administrateurs de l'organisation et des autres membres de la communauté.

En tant que rédacteur technique, comment puis-je contacter les administrateurs du programme Google Season of Docs si j'ai d'autres questions ou préoccupations ?

Vous pouvez contacter les administrateurs du programme Google Season of Docs en leur envoyant un e-mail à l'adresse SEASON-of-docs@google.com.

Une société de rédaction technique ou un cabinet de conseil peuvent-ils participer à Season of Docs ?

Oui, une organisation peut engager une entreprise pour effectuer le travail décrit dans sa proposition.

Comment faire référence à Season of Docs sur mon CV ?

Énumérez-le comme vous le feriez pour tout autre travail en indépendant, par exemple "J'ai travaillé comme rédacteur technique pour [nom du projet] dans le cadre du programme Season of Docs".

Fournissez-vous des certificats de réussite pour votre participation à Season of Docs ?

Nous ne sommes pas en mesure d'envoyer des certificats ni des confirmations de participation au projet aux rédacteurs techniques.

Pour les administrateurs d'organisations Open Source

Quels sont les critères d'éligibilité pour une organisation Open Source ?

Pour pouvoir participer en tant qu'organisation, 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é juridiquement constituée. Les entreprises doivent avoir déjà produit et publié un logiciel sous une licence Open Source Initiative, et au moins deux contributeurs doivent jouer le rôle d'administrateurs 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 comportant chacune un ou plusieurs projets Open Source. Si votre organisation possède des sous-organisations indépendantes, veuillez soumettre des demandes et des propositions distinctes pour chacune d'elles.

Une entreprise peut-elle soumettre plusieurs propositions de candidatures ?

Non. Veuillez n'envoyer qu'une seule candidature par organisation. Si votre organisation possède des sous-organisations (par exemple, si elle est une fondation qui gère de nombreux projets Open Source individuels), chaque projet doit soumettre sa propre demande, même si la subvention est gérée par l'organisation mère.

Un groupe de projets Open Source peut-il soumettre une proposition ensemble pour travailler sur un seul projet de documentation ?

Une organisation doit soumettre la demande de proposition et être responsable de la coordination du travail et de l'assistance des autres projets participants. Par exemple, un groupe de petits projets Open Source qui sont tous des plug-ins d'un projet plus important et qui souhaitent travailler sur un guide d'utilisation commun pour créer des plug-ins doit choisir une organisation pour diriger le projet.

Comment mon organisation recevra-t-elle les fonds ?

Pour recevoir des fonds, votre organisation doit disposer d'un compte Open Collective.

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

Les organisations peuvent inclure des fonds pour l'administration, le mentorat ou l'examen du travail dans le cadre du budget de leur projet.

Les frais de traitement des paiements sont-ils couverts par Google ?

Les frais de traitement des paiements ne sont pas couverts par Google, car ils varient en fonction du mode de paiement. Toutefois, Google prend en charge les frais de la plate-forme Open Collective. Si vous décidez d'utiliser Open Collective comme hôte fiscal, ces frais sont également pris en charge. Pour en savoir plus, consultez le guide d'octroi d'autorisations.

Comment mon organisation doit-elle budgétiser les coûts d'un rédacteur technique ?

Nous vous recommandons de consulter la section Écrire l'enquête sur les salaires Docs et de calculer les taux horaires. Vous pouvez également rejoindre la chaîne Write The Docs Slack et demander aux rédacteurs techniques intéressés de participer à une proposition sur la chaîne #Season-of-docs.

Mon organisation peut-elle utiliser la subvention Season of Docs pour payer un contributeur actuel ?

Oui. Toutefois, les propositions de projet doivent concerner de nouvelles tâches (y compris des tâches de maintenance, des révisions ou des mises à niveau de la documentation existante). Vous ne pouvez pas demander une subvention pour payer un travail déjà terminé.

Mon organisation peut-elle collaborer avec des élèves rédacteurs techniques ?

Vous pouvez demander à des élèves de rédacteurs techniques pour travailler sur votre projet. Si vous choisissez de travailler avec des élèves, nous vous recommandons vivement de limiter votre participation aux élèves qui:

  • Ils ont plus de 18 ans.
  • Être inscrits à un programme ou à un cours de rédaction technique ou de communication technique
  • Avoir un accès démontré au mentorat de rédaction technique dans le cadre de leur programme ou cours

Mon organisation peut-elle collaborer avec plusieurs rédacteurs techniques ?

Votre entreprise peut sélectionner et payer plusieurs rédacteurs techniques, mais tous les rédacteurs techniques travaillant avec votre organisation doivent travailler sur le projet que vous avez proposé. Travailler avec plusieurs rédacteurs techniques ajoutera plus de complexité à votre projet et nécessitera plus de bénévolat et de temps d'administration.

Mon organisation peut-elle faire appel à une société de rédaction technique pour travailler sur notre projet ?

Oui, votre organisation peut engager une société de rédaction technique pour travailler sur votre projet. Veuillez vous assurer que l'entreprise que vous engagez peut être payée par le biais d'Open Collective.

Notre rédacteur technique a abandonné avant la fin du programme. Pouvons-nous toujours recevoir les fonds restants ?

Nous vous encourageons vivement à rechercher un nouveau rédacteur technique pour terminer votre projet avant la fin du programme. Toutefois, le versement des fonds restants n'est pas basé sur l'achèvement du projet, mais sur l'achèvement de l'étude de cas et de l'évaluation finale.

Si votre projet n'a pas pu être mené à bien, votre étude de cas doit en examiner les raisons. Par exemple, vous avez peut-être constaté que vos outils de documentation sont très compliqués et qu'ils se révèlent un obstacle pour l'intégration d'un rédacteur technique, ou que votre projet impliquait de tester et de mettre à jour des tutoriels, et nécessitait une grande expérience en codage. Que recommanderiez-vous à d'autres projets, sur la base de votre expérience ? Incluez ces informations dans votre étude de cas.

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 entreprises doivent-elles définir la portée de leurs propositions de projet ?

Lorsque vous développez des idées de projet, essayez d'identifier les plus petits projets qui apporteront de la valeur à l'organisation (ils peuvent être étendus si le temps le permet). Plus petit, c'est mieux. Lorsque vous créez votre proposition de projet, nous vous recommandons de vous en tenir à des projets plus petits et plus détaillés plutôt qu'à des projets plus importants et moins spécifiés. Si votre projet nécessite une grande expertise dans le domaine, essayez d'inclure des projets sur lesquels une personne n'ayant pas ce profil pourrait travailler.

Puis-je participer en tant qu'administrateur d'organisation à Season of Docs et en tant que mentor à 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.

Notre organisation a participé aux précédents programmes Season of Docs. Sommes-nous éligibles à nouveau ?

Oui, les organisations qui ont participé à une saison précédente de programmes Docs peuvent envoyer une nouvelle demande.

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.