Phase actuelle:
Études de cas publiées. Voir la chronologie.
Cette page contient des conseils pour les organisations Open Source sur la façon d'évaluer et de sélectionner le rédacteur technique idéal pour leur proposition de projet Google Season of Docs.
Introduction
Les organisations Open Source doivent embaucher un rédacteur technique pour travailler sur le projet proposé. Les entreprises doivent trouver leur propre rédacteur technique. Les rédacteurs techniques intéressés par le travail avec des organisations participant à la Google Season of Docs peuvent consulter le dépôt GitHub de la Google Season of Docs et le canal #season-of-docs sur le serveur Slack Write the Docs.
Démarrer le processus
Nous vous recommandons de commencer à chercher un rédacteur technique dès que vous pensez que vous souhaitez participer à la Google Season of Docs.
Évaluer un rédacteur technique
Nous vous recommandons de demander aux rédacteurs techniques que vous envisagez des exemples de documentation précédemment développée afin de pouvoir évaluer leurs compétences et leur expérience en écriture technique.
Compétences et expérience en rédaction technique
Examinez l'expérience préalable du rédacteur technique. Dans l'idéal, le rédacteur technique doit avoir une certaine expérience dans la rédaction de documentation technique pour le secteur des logiciels. L'un des objectifs de la Google Season of Docs est de donner aux rédacteurs techniques l'occasion de s'impliquer dans des produits destinés aux développeurs. C'est pourquoi il n'est pas essentiel que l'auteur ait de l'expérience avec les API, les SDK ou d'autres plates-formes de développement, même si votre projet est axé sur une audience de développeurs.
Concentrez-vous sur les compétences linguistiques et de communication. Évaluez le travail précédent du rédacteur technique sous cet angle. Plus important encore: pouvez-vous comprendre ce que la personne a écrit ? Si vous souhaitez examiner en détail le langage du rédacteur technique, recherchez la cohérence dans la ponctuation et la formulation, une orthographe correcte et un langage clair. La formulation est-elle simple ou complexe ? Les phrases sont-elles courtes ou s'étendent-elles jusqu'à devenir difficiles à suivre ?
Prêtez attention à la conception et à la mise en page du document. Vérifiez la mise en page globale des exemples de documents. La conception est-elle logique ? Pouvez-vous facilement vous repérer dans le document ou le lot de documentation ? Le contenu est-il dupliqué ou présente-t-il des lacunes évidentes ?
Recruter un rédacteur technique
Les organisations doivent embaucher un rédacteur technique et remplir le formulaire de preuve d'embauche de rédacteur technique disponible en lien ci-dessous d'ici le 22 mai 2024 à 18h00 UTC.
Phase de recrutement d'un rédacteur technique terminée.
Avant de l'embaucher, discutez avec le rédacteur technique de la rémunération et du calendrier de paiement. Nous recommandons aux organisations de créer un calendrier de paiement avec les rédacteurs techniques en fonction des jalons du projet, y compris un paiement au lancement du projet. N'oubliez pas les dates de paiement, qui n'auront lieu que deux fois au cours du programme, ainsi que les montants lorsque vous créerez un calendrier de paiement.
Remarque : Les organisations qui n'ont pas embauché de rédacteur technique et qui n'ont pas envoyé le formulaire de preuve d'embauche d'un rédacteur technique avant le 22 mai 2024 à 18h UTC ne recevront pas de fonds lors du premier versement.