Phase actuelle:
Le programme Season of Docs 2019 s'est terminé le 6 mars 2020. Consultez la chronologie.
Cette page contient des conseils destinés aux rédacteurs techniques sur la façon de compléter les parties clés d'une application pour participer à Season of Docs. Ces informations vous aident à comprendre les facteurs que les organisations Open Source peuvent prendre en compte lorsqu'elles sélectionnent les projets de rédaction technique qu'elles souhaitent guider pendant Season of Docs.
Introduction
Les consignes ci-dessous s'appliquent de manière générale aux saisons de Google Docs. Chaque organisation Open Source individuelle peut avoir des critères d'évaluation spécifiques. Avant de soumettre votre candidature, vous pouvez contacter l'une des organisations participantes pour discuter de ses exigences et planifier votre proposition de projet. Consultez la phase d'exploration du rédacteur technique décrite dans le guide du rédacteur technique.
Formulaire de demande
Le formulaire de demande est disponible dans le guide du rédacteur technique pendant sa phase de candidature.
Une fois le formulaire envoyé, vous pouvez continuer à mettre à jour les informations qu'il contient jusqu'à la fin de la phase de candidature du rédacteur technique (28 juin 2019).
Informations personnelles
Le formulaire de demande requiert les informations personnelles suivantes:
Votre nom:indiquez votre nom complet. Season of Docs ne partagera pas ce nom avec les organisations Open Source et ne le publiera pas sur le site Web.
Un nom à afficher de votre choix:indiquez le nom que vous souhaitez utiliser comme identifiant public lors de votre participation à Season of Docs. Nous vous recommandons vivement de ne pas utiliser votre vrai nom complet comme nom à afficher. Season of Docs partagera votre nom à afficher avec l'organisation Open Source que vous indiquez sur votre formulaire d'inscription. Season of Docs publiera votre nom à afficher sur le site Web dans la liste des projets de rédaction technique acceptés.
Votre adresse e-mail:indiquez l'adresse e-mail associée à votre compte Google. (Vous devez disposer d'un compte Google pour participer à Season of Docs. Vous pouvez utiliser une adresse e-mail autre que Gmail avec un compte Google. consultez cet article d'aide.) Season of Docs utilise votre adresse e-mail pour communiquer avec vous et mettre les ressources du site Web à votre disposition. Season of Docs partagera cette adresse e-mail avec l'organisation Open Source que vous indiquez sur votre formulaire de demande. Season of Docs ne publiera pas cette adresse e-mail sur le site Web.
Vous trouverez ci-dessous un résumé de la manière dont Season of Docs utilise les informations de votre formulaire de demande.
Informations sur votre expérience de rédaction technique
Lorsque les mentors et les administrateurs de l'organisation Open Source examinent une proposition de projet, ils s'intéressent à votre expérience de rédaction technique. Vous pouvez fournir des détails sur le formulaire comme suit:
Expérience de rédaction technique récente:jusqu'à trois entrées où vous pouvez répertorier vos rôles de rédaction technique ou votre expérience professionnelle les plus récents. Si vous avez de l'expérience dans la documentation Open Source, mentionnez-la également ici. Résumez votre rôle, vos responsabilités et le travail que vous avez effectué. Vous pouvez indiquer des dates, le cas échéant.
Un lien vers votre CV: (facultatif) URL d'une version accessible au public de votre CV ou de votre curriculum vitae (CV).
Un lien vers vos exemples de devoirs: (facultatif) URL d'un portfolio accessible publiquement d'exemples écrits ou liens individuels vers des exemples de votre travail.
Autre information: (facultatif) Toutes les informations que vous souhaitez ajouter à cette application Par exemple, votre intérêt pour la documentation technique, les raisons pour lesquelles vous souhaitez participer à Season of Docs, ou toute autre expérience pertinente.
Proposition de projet
Votre proposition de projet est un résumé du travail de documentation que vous souhaitez effectuer lorsque vous travaillez avec l'organisation Open Source de votre choix pendant la saison des documents.
Vous pouvez soumettre jusqu'à trois propositions de projet. Toutes vos propositions de projet doivent se trouver sur le même formulaire de demande.
Consacrez du temps à votre proposition de projet, en tenant compte des directives suivantes.
Travail préparatoire:
Examinez la liste des organisations Open Source participantes, puis choisissez une ou plusieurs organisations qui vous intéressent. Jetez un œil aux idées de projet proposées par chacune des organisations Open Source que vous avez choisies.
Si l'organisation qui vous intéresse n'a suggéré aucune idée, vous pouvez examiner la liste générique d'idées de projets et baser votre idée sur l'une d'elles. Vous pouvez également choisir de proposer votre propre idée, que l'organisation ait publié des idées ou non.
Contactez une ou plusieurs des organisations participantes pour discuter des idées du projet. Pour prendre contact, 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.
Votre proposition de projet sur le formulaire de demande:
Nom de l'organisation Open Source:saisissez le nom de l'organisation Open Source avec laquelle vous souhaitez travailler pendant la saison des documents. Il doit s'agir de l'une des organisations participantes affichées sur le site Web Season of Docs.
Open Source project name (Nom du projet Open Source) : nom du projet Open Source sur lequel vous souhaitez travailler pendant la saison des documents. Le projet doit appartenir à l'une des organisations participantes figurant sur le site Web Season of Docs. Pour certaines organisations, le nom de l'organisation et le nom du projet peuvent être identiques.
Nom du projet de rédaction technique que vous proposez. Indiquez un titre court et descriptif qui résume l'objectif principal du travail que vous proposez.
Une description détaillée : Soyez aussi précis que possible dans la description du projet de rédaction technique que vous proposez. Vous pouvez saisir plusieurs paragraphes dans le champ de description. Voici quelques idées de contenus à inclure:
- Fournissez des détails sur la documentation que vous proposez de créer ou de mettre à jour. Si vous prévoyez de mettre à jour un document ou un site existant, incluez un lien et décrivez les mises à jour proposées. Si vous proposez un nouveau document ou un nouveau site, décrivez le contenu et l'audience.
- Expliquez pourquoi vous proposez la nouvelle documentation ou les mises à jour.
- Si vous avez discuté du projet avec une personne de l'organisation Open Source, incluez un résumé des résultats de ces discussions.
- Faites attention à la langue et au style de votre proposition. L'organisation Open Source peut les utiliser comme facteur d'évaluation de la proposition.
- Ne fournissez pas de lien vers la description de votre projet. La description doit inclure tous les détails définitifs de votre projet. L'organisation Open Source doit pouvoir effectuer une sélection en fonction du contenu du formulaire de demande et non du contenu stocké ailleurs. Si vous devez créer un lien vers un autre contenu qui complète la description, ce n'est pas un problème. Toutefois, sachez que seul le contenu du formulaire de demande est utilisé pour la sélection du projet.
Autres champs importants du formulaire de demande
Vous trouverez ci-dessous des consignes concernant les autres informations clés à fournir dans le formulaire de demande:
Choisir un projet de durée standard ou de longue durée:la période standard pour la phase de développement des documents de Season of Docs est de trois mois. Si votre projet nécessite un délai plus long, vous devez l'indiquer sur le formulaire de demande après consultation avec l'organisation Open Source de votre choix. Consultez la description des projets de longue durée.
Acceptation du bénéfice de la saison de Docs:Season of Docs verse une somme d'argent aux rédacteurs techniques qui terminent leurs projets avec succès, à condition que le rédacteur technique veuille accepter le paiement. Consultez les informations sur les allocations de rédacteurs techniques. Ce commentaire est facultatif. Si vous ne souhaitez pas recevoir la bourse, indiquez votre choix sur le formulaire de demande.
Comment Season of Docs utilise les informations de votre formulaire d'inscription
Cette section résume comment Season of Docs utilise les informations de votre formulaire de demande. Les sections précédentes de cette page décrivent les principaux champs en détail.
Le tableau répertorie les champs clés. Pour chaque champ, le tableau indique si Season of Docs:
- Transmet les informations à l'organisation Open Source que vous avez spécifiée dans votre formulaire de demande.
- Publie les informations dans la liste des projets de rédaction technique acceptés sur le site Web "Season of Docs".
| Informations sur le formulaire | Partagé avec une organisation Open Source ? | Apparaît sur le site Web Season of Docs ? |
|---|---|---|
| Nom complet | ||
| Nom à afficher | ||
| Adresse e-mail | ||
| Expérience récente de rédaction technique | ||
| Lien vers le CV | ||
| Lien vers des exemples de travail | ||
| Autre chose à ajouter | ||
| Nom de l'organisation/du projet Open Source | ||
| Nom et description du projet de rédaction technique | ||
| Projet de longue durée ou de durée standard | ||
| Acceptation d'une bourse |
Description des symboles utilisés dans le tableau ci-dessus:
| Symbole | Signification du symbole |
|---|---|
| Oui | |
| Non |
Remarques
Voici quelques points supplémentaires à retenir:
Envoyer plusieurs propositions de projets:vous pouvez soumettre plusieurs propositions de projets, mais Season of Docs n'accepte qu'une seule proposition de projet par rédacteur technique. Vous ne pouvez envoyer qu'un seul formulaire de demande. Le formulaire permet d'envoyer jusqu'à trois propositions de projets.
Nombre total de projets d'écriture technique dans le programme:la saison de Docs ne peut accepter qu'un certain nombre maximal de projets d'écriture technique au total. Découvrez comment fonctionne l'allocation d'emplacements.
Guides associés
Découvrez nos conseils pour les mentors sur la façon d'évaluer les propositions des rédacteurs techniques. Comprendre les critères de sélection des mentors vous aide à élaborer une proposition plus susceptible de réussir.
Pour savoir quand et comment envoyer votre candidature pour les saisons de Docs, consultez le guide du rédacteur technique.