Questions fréquentes (FAQ)

Phase actuelle:
Études de cas publiées. Voir la chronologie.

Général

La saison Google Docs est-elle un programme de recrutement ?

Non. Si vous souhaitez travailler pour Google, consultez le site Web des offres d'emploi Google.

Notre organisation souhaite participer à la Google 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 le canal #season-of-docs dans le Slack Write the Docs ou sur vos canaux de réseaux sociaux pour demander de l'aide ou des suggestions).

Quels types de projets les organisations peuvent-elles proposer ?

Voici quelques idées :

  • Créez un site de documentation sur une plate-forme à déterminer par le rédacteur technique et l'organisation Open Source, et publiez 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 améliorer l'expérience utilisateur ou proposer une architecture de l'information plus accessible.

  • Rédigez une présentation conceptuelle ou une introduction d'un produit ou d'une fonctionnalité. Souvent, une équipe crée sa documentation technique de bas en haut, ce qui entraîne une grande quantité de détails, mais 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 pratiques ciblés pour des tâches spécifiques.

  • Créez un guide du contributeur qui inclut des informations de base sur la prise en main du projet Open Source, ainsi que les règles concernant les contrats de licence, les processus de requêtes pull et d'examens, la compilation du projet, etc.

Une vidéo est-elle un projet possible pour la Google Season of Docs ?

Oui. Assurez-vous que les exigences vidéo sont bien définies et sachez que la production d'une vidéo de haute qualité prend beaucoup de temps et de ressources.

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

Un audit de la documentation est un excellent projet pour la saison Google des documents. Tenez compte de la quantité de documentation dont vous disposez déjà. Si vous en avez beaucoup, vous devrez peut-être réduire le champ d'application (par exemple, en effectuant un audit uniquement sur 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 votre projet.

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

La Google Season of Docs propose un dépôt GitHub avec un modèle et une checklist pour effectuer des audits de documentation. D'autres modèles seront ajoutés à mesure qu'ils seront créés.

Le projet Good Docs s'efforce de créer des modèles de documentation minimum viables pour l'Open Source.

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

Non. Il arrive parfois que les projets ne se déroulent pas comme prévu ou que les exigences changent. Nous n'exigeons pas aux organisations d'utiliser la documentation ou d'autres supports produits, mais nous nous attendons à ce que l'évaluation et l'étude de cas finales 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 l'utiliser ou d'utiliser d'autres supports.

Où se déroule la Google Season of Docs ?

La saison des documents Google se déroule entièrement en ligne. Il n'est pas obligatoire de voyager dans le cadre du programme.

Comment me tenir informé de la Google Season of Docs ?

Pour connaître les dernières actualités et annonces concernant la Google Season of Docs, consultez la liste de diffusion d'annonces sur season-of-docs-announce. Rejoignez le groupe pour recevoir des informations par e-mail.

Puis-je ajouter le calendrier de la saison Google des documents à mon agenda ?

Accédez à http://goo.gle/2NeZVew pour vous abonner au calendrier de la saison Google des documents.

Que puis-je faire pour faire connaître la saison Google des documents ?

Vous pouvez tweeter à propos du programme, rédiger des articles de blog, publier des vidéos ou organiser un événement ou une session d'information dans votre région. Nous vous proposons des exemples de contenus et de ressources que vous pouvez distribuer à votre communauté (organisation, groupe d'auteurs et autres contacts).

Comment organiser ou animer une session d'information ou une rencontre pour la Google Season of Docs ?

Vous pouvez planifier un rendez-vous à l'heure et au lieu qui vous conviennent. Consultez le Règlement du programme et utilisez l'exemple de contenu.

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

Oui, les résultats de la Google Season of Docs pour le programme 2019 sont disponibles sur le blog Google Open Source (2019, 2020).

Vais-je recevoir un T-shirt Google Season of Docs ?

Non. En raison de contraintes liées à l'expédition internationale, Google Season of Docs ne peut plus fournir de t-shirts aux participants qui terminent avec succès leur projet Google Season of Docs.

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

Consultez le guide de l'administrateur de l'organisation et le guide de l'auteur technique.

Si, après avoir lu toute la documentation, vous n'obtenez toujours pas de réponse, envisagez de discuter de vos questions avec la communauté Google Season of Docs sur la liste de discussion. Consultez les informations sur les canaux de discussion et sur la façon de nous contacter.

Comment puis-je devenir mentor pour la Google Season of Docs ?

Le programme Google 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 pris en charge, et comment leurs contributions à la documentation seront examinées et approuvées dans le cadre de la demande de l'organisation. Si vous souhaitez encadrer des rédacteurs techniques dans le cadre de la Google Season of Docs, contactez les administrateurs de votre organisation pour vous porter volontaire.

Le Season of Docs est-il semblable au Google Summer of Code ?

Non. Google Season of Docs est destiné aux personnes ayant une certaine expérience en 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 à la Google Season of Docs ?

La Google Season of Docs n'a pas de procédure officielle de candidature pour les rédacteurs techniques. Pour participer à la Google Season of Docs en tant que rédacteur technique, contactez directement les organisations Open Source en suivant les instructions sur leur page du programme Google Season of Docs. Vous pouvez également exprimer votre intérêt en vous ajoutant au Directory of Technical Writers for Google Season of Docs (Répertoire des rédacteurs techniques pour la Google Season of Docs). Pour en savoir plus, consultez le guide pour les rédacteurs techniques.

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

Les outils et frameworks de documentation que vous utiliserez dépendent de l'entreprise avec laquelle vous souhaitez collaborer. L'objectif de la Google Season of Docs est, en partie, de permettre aux rédacteurs techniques de se familiariser avec les outils et les frameworks impliqués dans la documentation des produits Open Source. Pour cette raison, il n'est généralement pas nécessaire de disposer de connaissances détaillées sur des plates-formes de documentation spécifiques avant de commencer votre projet Google Season of Docs.

Toutefois, la plupart des organisations Open Source utilisent une variante de Markdown ou un autre langage de balisage pour leur documentation. Nous vous recommandons de découvrir la langue utilisée par l'organisation de votre choix et de vous familiariser avec sa syntaxe. Markdown est un bon point de départ, car les fichiers README GitHub utilisent une variante de Markdown. Consultez le guide GitHub sur Markdown.

Découvrez si l'organisation de votre choix 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 Read the Docs ou GitHub Pages. Une fois que vous avez déterminé la plate-forme utilisée par l'entreprise, explorez et testez le langage et le framework appropriés. Cela vous permet de vous lancer rapidement dans votre projet Open Source et vous met en position de donner de bons conseils sur le projet Open Source de votre choix.

Quels langages de programmation dois-je connaître pour participer aux projets de la Google Season of Docs ?

Selon la nature de votre projet de documentation, vous devrez peut-être connaître un langage de programmation. Gardez cela à l'esprit lorsque vous choisissez et proposez un projet de documentation, et consultez l'organisation Open Source pour connaître le niveau de familiarité requis.

Les rédacteurs techniques qui travaillent déjà sur un projet Open Source peuvent-ils continuer à le faire dans le cadre de la Google Season of Docs ?

Oui, mais l'entreprise doit indiquer dans sa proposition la relation antérieure ou en cours du rédacteur technique avec le projet.

Quels sont les critères d'éligibilité à remplir pour participer ?

Dois-je avoir une expérience ou une formation préalable en tant que rédacteur technique ?

Une expérience ou une formation en rédaction technique est préférable, mais pas indispensable. Lorsque vous envoyez une lettre d'intérêt à une entreprise, vous pouvez décrire votre expérience ou toute formation que vous avez suivie en rédaction technique. Vous devez pouvoir fournir des preuves de votre intérêt pour la documentation technique ou la documentation Open Source, y compris des exemples de documentation que vous avez rédigée. L'organisation Open Source recherche des rédacteurs techniques ayant le niveau d'expérience dont elle a besoin pour mener à bien ses projets Google Season of Docs.

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

Oui. Google fournira des subventions aux organisations acceptées pour les utiliser afin d'employer des rédacteurs techniques.

À quoi ressemble une bonne déclaration d'intérêt pour 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 de discuter de leurs idées avec elle avant d'envoyer leur déclaration. Consultez le guide de création de votre déclaration d'intérêt.

Combien de temps dure la participation à la Google Season of Docs ?

La taille des projets varie, mais ils nécessitent entre cinq et 30 heures par semaine pendant le programme. Toutefois, la durée de votre mission dépend de la nature du projet convenu avec votre organisation. Avant de vous engager, vous devez évaluer le projet et discuter d'une estimation de la durée avec l'organisation Open Source.

Puis-je envoyer une demande d'organisation pour créer de la documentation pour un projet Open Source en tant qu'individu ? Je souhaite créer une série d'articles de blog, de vidéos ou d'autres supports expliquant comment utiliser un projet ou un outil Open Source, mais je ne fais pas partie du projet ni n'y contribue.

Non. Vous ne devez envoyer une proposition que si vous pouvez recevoir des fonds au nom du projet Open Source. Si vous souhaitez participer à un projet, contactez-le et collaborez sur une proposition de candidature.

Je suis étudiant. Puis-je participer à la Google Season of Docs ? La Google Season of Docs m'apprendra-t-elle à devenir rédacteur technique ?

Les étudiants peuvent travailler avec des organisations acceptées, mais la Google Season of Docs n'a pas pour but d'enseigner les compétences en rédaction technique. Les rédacteurs techniques participants doivent posséder des compétences professionnelles en rédaction technique ou une expérience pertinente équivalente. Les étudiants qui souhaitent participer doivent veiller à mettre en avant leur expérience pertinente en matière de rédaction et de révision lors de leur candidature.

Puis-je participer à la Google Season of Docs en tant que rédacteur technique et au Google Summer of Code en tant qu'étudiant ?

Nous déconseillons aux nouveaux contributeurs ou aux étudiants acceptés dans le programme Google Summer of Code de postuler pour devenir rédacteur technique Google Season of Docs.

La Google Season of Docs n'est pas destinée aux débutants, mais aux personnes qui ont déjà une bonne expérience et des compétences solides en écriture technique. Les rédacteurs techniques de la Google Season of Docs ne sont pas encadrés. Ils doivent être autonomes et motivés pour élaborer leur plan d'attaque du projet de l'organisation avec un minimum d'aide 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 entreprise ou une société de conseil spécialisée dans la rédaction technique peut-elle participer à la Google Season of Docs ?

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

Comment faire référence à la Google Season of Docs dans mon CV ?

Indiquez-le comme vous le feriez pour n'importe quel autre travail indépendant: "Travaillé en tant que rédacteur technique pour [nom du projet] dans le cadre du programme Google Season of Docs".

Fournissez-vous des certificats de réussite pour les participants à la Google Season of Docs ?

La Google Season of Docs ne peut pas envoyer de certificats ni de confirmations de participation au projet aux rédacteurs techniques.

Pour les administrateurs d'organisations open source

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

Pour pouvoir participer en tant qu'organisation, vous devez être un groupe qui gère un projet logiciel Open Source ou à code source ouvert actif, tel que BRL-CAD. Le projet n'a pas besoin d'être une entité légalement constituée. Pour participer au programme, les organisations doivent déjà avoir produit et publié des logiciels sous une licence approuvée par l'Open Source Initiative et disposer d'au moins deux contributeurs qui serviront d'administrateurs de l'organisation pendant toute la durée du programme Google Season of Docs.

Consultez également les critères d'éligibilité décrits dans les Règles du programme et les Programmes de sanctions et informations sur les pays du Trésor américain.

L'organisation est-elle équivalente à un projet Open Source ?

Une organisation peut avoir un ou plusieurs projets Open Source. Certaines organisations, comme les fondations, peuvent avoir plusieurs sous-organisations, chacune ayant un ou plusieurs projets open source. Si votre organisation comporte des sous-organisations indépendantes, envoyez des demandes et des propositions distinctes pour chacune d'elles.

Une organisation peut-elle envoyer plusieurs demandes de proposition ?

Non. N'envoyez qu'une seule demande par organisation. Si votre organisation comporte des sous-organisations (par exemple, si votre organisation est une fondation avec de nombreux projets Open Source individuels), chaque projet doit envoyer sa propre demande, même si les fonds de la subvention sont gérés par l'organisation mère.

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

Une organisation doit envoyer 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 pour un projet plus important et qui souhaitent travailler sur un guide d'instructions commun pour la création de 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 participer à la Google Season of Docs ?

Les organisations peuvent inclure des fonds pour l'administration, le mentorat ou l'évaluation des travaux dans le budget de leur projet.

Google prend-il en charge les frais de traitement des paiements ?

Les frais de traitement des paiements ne sont pas couverts par Google, car ils ont tendance à varier en fonction du mode de paiement. Toutefois, Google couvre les frais de plate-forme Open Collective. Si vous décidez d'utiliser Open Collective comme hôte fiscal, ces frais sont également couverts. Pour en savoir plus, consultez le guide sur la réception de subventions.

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

Nous vous recommandons de consulter l'enquête sur les salaires de Write the Docs et de calculer les tarifs horaires. Vous pouvez également rejoindre le Slack Write The Docs et demander aux rédacteurs techniques intéressés de faire une offre dans le canal #season-of-docs.

Can my organization use the Google Season of Docs grant to pay a current contributor?

Oui. Toutefois, les propositions de projet doivent concerner de nouveaux travaux (y compris la maintenance, la révision ou la mise à niveau de la documentation existante). Vous ne pouvez pas demander une subvention pour payer un travail déjà effectué.

Mon organisation peut-elle travailler avec des rédacteurs techniques étudiants ?

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

  • avoir plus de 18 ans ;
  • Vous êtes inscrit à un programme ou à un cours de rédaction ou de communication technique.
  • Avoir accès à un mentorat en écriture technique via son programme ou son cours

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

Votre organisation peut sélectionner et payer plusieurs rédacteurs techniques, mais tous les rédacteurs techniques qui travaillent avec votre organisation doivent travailler sur le projet que vous avez proposé. Travailler avec plusieurs rédacteurs techniques complexifie votre projet et nécessite plus de temps de bénévolat et d'administration.

Mon organisation peut-elle engager une entreprise de rédaction technique pour travailler sur notre projet ?

Oui, votre organisation peut engager une entreprise de rédaction technique pour travailler sur votre projet. Assurez-vous que l'entreprise que vous engagez peut être payée via Open Collective.

Notre rédacteur technique a abandonné avant la fin du programme. Notre organisation est-elle toujours éligible pour recevoir les fonds restants ?

Nous vous encourageons vivement à essayer de trouver un nouvel rédacteur technique pour terminer votre projet avant la fin du programme. Toutefois, le versement des fonds restants ne dépend pas de l'achèvement du projet, mais de 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 expliquer pourquoi. Par exemple, vous avez peut-être constaté que vos outils de documentation étaient très complexes et constituaient un obstacle à 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 expérience de codage approfondie. Que recommanderiez-vous à d'autres projets, d'après votre expérience ? Incluez ces informations dans votre étude de cas.

Une demande d'organisation peut-elle être examinée avant la date limite d'envoi ?

Malheureusement, Google Season of Docs n'est pas en mesure de fournir des commentaires sur la demande de l'organisation.

Comment les entreprises doivent-elles définir le champ d'application de leurs propositions de projet ?

Lorsque vous développez des idées de projets, essayez de trouver les plus petits projets qui apporteront de la valeur à l'organisation (mais qui peuvent être développés si le temps le permet). Plus la taille est petite, mieux c'est. Lorsque vous créez votre proposition de projet, nous vous recommandons de vous concentrer sur des projets plus petits et plus détaillés que des projets plus volumineux et moins précis. Si votre projet nécessite une grande expertise dans le domaine, essayez d'inclure des projets sur lesquels une personne sans cette expérience pourrait travailler.

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

Oui. La Google Season of Docs et le Google Summer of Code sont deux programmes distincts. Si vous avez la bande passante nécessaire pour participer aux deux programmes, c'est tout à fait acceptable.

Notre organisation a déjà participé à des éditions précédentes de la Google Season of Docs. Notre organisation peut-elle faire une nouvelle demande ?

Oui, les organisations qui ont participé à des éditions précédentes de la Google Season of Docs peuvent à nouveau postuler.

Données archivées

Comment supprimer mes informations de l'archive de la Google Season of Docs ?

Contactez-nous pour faire supprimer vos informations.