Questions fréquentes (FAQ)

Phase actuelle:
Le programme Saison 2021 de Docs s'est terminé le 14 décembre 2021. Consultez le calendrier.

Questions d'ordre général

Season of Docs est-il un programme de recrutement ?

Non. Si vous souhaitez travailler chez Google, veuillez consulter le site Web de Google Offres d'emploi.

Quelles sont les modifications apportées à la saison 2021 de Docs ?

La saison de Docs 2021 a connu des changements importants par rapport aux années précédentes, y compris:

  • Les rédacteurs techniques ne demandent plus à être mis en correspondance avec des entreprises par le biais de Google.
  • Les entreprises soumettent des propositions de projet, y compris un budget et des métriques,
  • Les organisations acceptées reçoivent des subventions qu'elles utilisent pour payer les rédacteurs techniques.
  • Les organisations soumettent des évaluations finales et des études de cas

Pourquoi avez-vous apporté ces modifications à Season of Docs ?

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 efficaces en matière de documentation Open Source, nous espérons avoir un impact plus important à long terme.

Notre organisation aimerait participer à la saison 2021 des documents Google, mais nous ne savons pas par où commencer.

Consultez notre liste complète d'idées de projet ! Vous pouvez également contacter la communauté des rédacteurs techniques (essayez le canal #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 premier ensemble 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 de l'information plus accessible.

  • Présentez un produit ou une fonctionnalité, ou rédigez une présentation conceptuelle. Souvent, une équipe crée sa documentation technique de bas en haut, ce qui génère beaucoup 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 d'utilisation dédiés à des tâches spécifiques.

  • Créez un guide du contributeur comprenant des informations de base sur les premiers pas en tant que contributeur d'un projet Open Source, ainsi que des règles concernant les contrats de licence, les processus de demandes d'extraction et d'examen, 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 de 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 documentation est-il un projet raisonnable pour Season of Docs ?

Un audit de la documentation est un excellent projet pour Season of Docs. Tenez compte de 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 ne disposez que de peu ou pas de documentation, vous pouvez inclure la création de la documentation manquante ayant la priorité la plus élevée dans le cadre de votre projet.

Existe-t-il des modèles de documentation que les entreprises et les rédacteurs techniques peuvent utiliser ?

Season of Docs comporte un dépôt GitHub avec un modèle et une checklist pour effectuer des audits de la documentation. Nous espérons ajouter d'autres modèles à mesure qu'ils seront créés.

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 documents produits, mais nous nous attendons à ce que l'évaluation finale et l'étude de cas comprenne une discussion sur les raisons pour lesquelles la documentation n'a pas été utilisée et sur la manière dont le projet a pris la décision de ne pas utiliser la documentation ou d'autres supports.

Où se trouve la saison des documents Google ?

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

Comment puis-je recevoir des informations sur Season of Docs ?

Consultez la liste de diffusion des annonces sur season-of-docs-announce pour découvrir les dernières informations et annonces concernant Season of Docs. Rejoignez le groupe pour recevoir les mises à jour par e-mail.

Puis-je ajouter la chronologie d'une saison des documents Google à mon agenda ?

Oui, vous pouvez l'ajouter en cliquant sur ce lien.

Que puis-je faire pour faire connaître cette saison ?

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 contenus et de ressources que vous pouvez utiliser à distribuer à 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'heure et au lieu 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 de 2019 et 2020 ?

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

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

Non, en raison de contraintes d'expédition internationales, nous ne serons plus en mesure de fournir des t-shirts aux participants qui terminent leur projet Season of Docs avec succès.

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

Consultez le guide pour les administrateurs en 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 concernant les canaux de discussion et découvrez comment nous contacter.

Comment devenir mentor pour Season of Docs ?

La saison 2021 de 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, et comment 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 des documents est-elle similaire à 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 pourront-ils postuler pour une saison de Docs ?

Aucune candidature officielle de rédacteur technique n'est disponible pour la saison 2021 de Docs. Pour participer à la saison 2021 des documents en tant que rédacteur technique, contactez directement les organisations Open Source en suivant les instructions figurant sur la page du programme "Saison des documents". Vous pouvez également indiquer que vous êtes intéressé 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 frameworks 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'un des objectifs de Season of Docs est que les projets Open Source aident les rédacteurs techniques à se familiariser avec les outils et frameworks impliqués dans la documentation des produits Open Source. Pour cette raison, il n'est généralement pas nécessaire d'avoir une connaissance approfondie des plates-formes de documentation spécifiques avant de commencer votre projet saisonnier de Docs.

Cela dit, la plupart des organisations Open Source utilisent un certain type de Markdown ou un autre langage de balisage pour leur documentation. Nous vous recommandons d'identifier le langage utilisé par l'organisation de votre choix 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 relatif au Markdown.

Déterminez si l'organisation que vous avez choisie héberge déjà sa documentation sur un site Web et, si oui, 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 les pages GitHub. Une fois que vous avez identifié la plate-forme utilisée par l'organisation, explorez et testez le langage et le framework appropriés. Cela vous permet de démarrer rapidement avec votre projet Open Source et 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 à des 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 pour connaître le niveau de familiarité requis.

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

Oui, mais l'organisation doit noter la relation précédente ou actuelle du rédacteur technique avec le projet dans sa proposition.

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

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 préalable en rédaction ou en rédaction technique est préférable, mais pas essentielle. 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 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ée. L'organisation Open Source recherchera des rédacteurs techniques avec le niveau d'expérience dont elle a besoin pour s'assurer de la réussite de ses projets Season of Docs.

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

Oui. Google accordera des subventions aux organisations acceptées pour qu'elles puissent employer 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 de discuter de leurs idées avant de soumettre leurs propres déclarations. Consultez le guide pour créer une déclaration d'intérêt.

Combien de temps prend la participation à une saison de Docs ?

La taille des projets varie, mais va de 5 à 30 heures par semaine pendant le programme. Cependant, le temps passé 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 d'une 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'en fais pas partie 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 l'équipe du projet et à collaborer sur une proposition de candidature.

Je suis étudiant. Puis-je participer à la saison 2021 de Docs ? Est-ce que Season of Docs m'apprendra à être 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 avoir des compétences professionnelles de rédaction technique ou une expérience é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 s'adressent à des organisations et des projets intéressés.

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

Bien que cela ne soit pas contraire au règlement pour le moment, nous vous conseillons vivement de ne pas intégrer les étudiants acceptés à Google Summer of Code pour devenir rédacteur technique Season of Docs. Les élèves doivent se concentrer sur les travaux liés à Google Summer of Code plutôt que sur les candidatures.

De plus, Season of Docs n'est pas destiné aux débutants. Il s'adresse 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 être auto-organisés et motivés pour élaborer 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 de conseil peut-elle participer à Season of Docs ?

Oui, une entreprise peut faire appel à 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 indépendant, par exemple "A travaillé en tant que rédacteur technique pour [nom du projet] dans le cadre du programme Saison des documents".

Fournissez-vous des certificats de réussite pour votre participation à la saison des documents ?

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 bénéficier d'une organisation Open Source ?

Pour pouvoir participer en tant qu'organisation, vous devez être un groupe exécutant un projet logiciel libre/Open Source actif, tel que BRL-CAD. Le projet n'a pas besoin d'être une entité juridiquement constituée. Les organisations doivent avoir déjà produit et publié un logiciel sous une licence Open Source Initiative approuvée. Elles doivent également compter au moins deux contributeurs comme administrateurs 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" est-il l'équivalent d'un projet Open Source ?

Une organisation peut avoir un ou plusieurs projets Open Source. Certaines organisations, telles que les fondations, peuvent comporter plusieurs sous-organisations comportant chacune un ou plusieurs projets Open Source. Si votre organisation comporte des sous-organisations indépendantes, veuillez soumettre des demandes et des propositions distinctes pour chacune d'elles.

Une entreprise peut-elle soumettre plusieurs demandes de propositions ?

Non. Veuillez n'envoyer qu'une seule demande 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 les fonds de la subvention sont gérés par l'organisation mère.

Un groupe de projets Open Source peut-il soumettre une proposition 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 provenant des autres projets participants. Par exemple, un groupe de petits projets Open Source qui sont tous des plug-ins d'un projet plus vaste 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 leurs projets.

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

Nous vous recommandons de consulter É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 sur la chaîne #season-of-docs.

Mon organisation peut-elle utiliser la subvention Saison des documents Google pour payer un contributeur actuel ?

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

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

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

  • ont plus de 18 ans ;
  • être inscrits à un cours ou à un programme de rédaction technique ou de communication technique ;
  • Avoir un accès démontré au mentorat de rédaction technique dans le cadre de son programme ou de son 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é. La collaboration 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 rémunérée par le biais d'Open Collective.

Notre rédacteur technique a abandonné le programme avant la fin du programme. Sommes-nous toujours en droit de recevoir les fonds restants ?

Nous vous encourageons vivement à chercher 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 la réalisation de l'étude de cas et de l'évaluation finale.

Si votre projet n'a pas pu être réalisé, votre étude de cas devrait en examiner les raisons. Par exemple, vous avez peut-être constaté que vos outils de documentation sont très complexes et se sont avérés un obstacle à l'intégration d'un rédacteur technique, ou que votre projet implique des tests et des mises à jour de 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.

Les candidatures d'une organisation peuvent-elles être examinées avant la date limite d'envoi ?

Malheureusement, nous ne sommes pas en mesure de fournir des commentaires sur la demande d'inscription 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 (mais qui peuvent être étendus si le temps le permet). Plus petit, mieux c'est. 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 qui sont moins spécifiés. Si votre projet nécessite une grande expertise dans le domaine, essayez d'inclure des projets qui pourraient être étudiés par une personne sans cette expérience.

Puis-je participer en tant qu'administrateur d'une organisation à Season of Docs et en tant que mentor pour 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é à la saison précédente de Google Docs. Pouvons-nous envoyer une nouvelle demande de participation ?

Oui, les organisations qui ont participé à des programmes Season of Docs précédents peuvent à nouveau postuler.

Données archivées

Comment supprimer mes informations des archives de la saison des documents Google ?

Contactez-nous pour demander la suppression de vos informations.