Phase actuelle:
Le programme Season of Docs 2020 s'est terminé le 15 mars 2021. Consultez la chronologie.
Cette page contient des consignes destinées aux organisations Open Source pour évaluer les propositions de projets de rédaction technique et sélectionner les projets qu'elles souhaitent parrainer dans Season of Docs.
Introduction
Les rédacteurs techniques envoient leurs propositions Season of Docs afin de travailler sur un projet avec l'organisation Open Source de leur choix. Les administrateurs du programme Google transmettent les propositions aux organisations Open Source pour une évaluation et une sélection de projets. Pour en savoir plus sur les étapes à suivre, consultez le guide de l'administrateur de l'organisation.
Évaluation des propositions des rédacteurs techniques
Compétences et expérience en rédaction technique
Examinez l'expérience antérieure du rédacteur technique. La proposition du rédacteur technique comprend des informations sur sa dernière expérience de rédaction technique. Dans l'idéal, le candidat doit avoir une expérience préalable de la rédaction de documentation technique pour le secteur des logiciels. L'un des objectifs de Season of Docs est de donner aux rédacteurs techniques la possibilité de s'impliquer dans les produits destinés aux développeurs. Pour cette raison, il n'est pas essentiel que le rédacteur ait déjà de l'expérience avec les API, les SDK ou d'autres plates-formes de développement, même si votre projet s'adresse à un public de développeurs.
Concentrez-vous sur les compétences linguistiques et en matière de communication. Évaluer la proposition du rédacteur technique de ce point de vue. Plus important encore: pouvez-vous comprendre ce que la personne a écrit ? En tant que mentor, votre rôle sera d'aider le rédacteur technique à maîtriser les processus, les outils et le code Open Source. Vous ne voulez pas non plus avoir à revoir le texte de la documentation résultante. Si vous souhaitez examiner en détail la langue de la proposition, assurez-vous de la cohérence de la ponctuation et de la formulation, de l'orthographe et de la clarté du texte. La formulation est-elle simple ou compliquée ? Les phrases sont-elles courtes ou s'exécutent-elles jusqu'à ce qu'elles deviennent difficiles à suivre ?
Faites attention à la conception et à la mise en page du document. Dans le cadre de sa proposition, le rédacteur technique a la possibilité de fournir des exemples de documentation qu'il a développés. Vérifiez la mise en page globale du ou des exemples de documents. La conception est-elle logique ? Pouvez-vous facilement vous repérer dans le document ou le jeu de documentation ? Y a-t-il du contenu en double ou y a-t-il des lacunes évidentes ?
La proposition
Vérifiez que la proposition répond à vos besoins. La proposition est-elle liée à l'une des idées de projet que vous avez envoyées pour la saison des documents de cette année ? Si le rédacteur technique a proposé une nouvelle idée, vérifiez que celle-ci répond aux besoins de votre projet Open Source et que vous disposez des bonnes personnes pour l'aider à atteindre les objectifs du projet proposé.
Faites preuve d'enthousiasme et de minutie. La proposition démontre-t-elle que le rédacteur technique est enthousiaste à propos du projet ? Déterminez s'ils ont réfléchi et travaillé sur la proposition, soit en consultant votre entreprise pendant la phase d'exploration, soit en ajoutant leurs propres réflexions sur la manière d'atteindre les objectifs du projet.
Questions fréquentes
Comment déterminons-nous le nombre de projets à soumettre ?
Concentrez-vous sur un ou deux projets. Si votre organisation a la capacité d'encadrer davantage, vous pouvez en soumettre davantage. Pour chaque projet de rédacteur technique, vous avez besoin d'au moins un mentor (de préférence deux) qui s'engage à parrainer uniquement ce projet.
Lisez les informations sur le fonctionnement de l'allocation d'emplacements pour Season of Docs.
Comment choisissons-nous la proposition de rédaction technique à accepter ?
Veillez à sélectionner les meilleures propositions de rédacteurs techniques que vous avez reçues. Autrement dit, sélectionnez les propositions qui correspondent le mieux à vos besoins et qui correspondent le mieux aux consignes d'évaluation répertoriées ci-dessus.
Où se trouvent les formulaires dont nous avons besoin pour envoyer les propositions sélectionnées ?
Consultez le guide de l'administrateur de l'organisation.