Phase actuelle:
Le programme Season of Docs 2021 s'est terminé le 14 décembre 2021. 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 leur 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.
Évaluer un rédacteur technique
Nous vous recommandons de demander des exemples de documentation précédemment développée aux rédacteurs techniques que vous envisagez, afin de pouvoir vous concentrer sur l'évaluation de leurs compétences et de leur expérience en rédaction 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 expérience préalable de la rédaction de documentations techniques pour l'industrie du logiciel. L'un des objectifs de la Google Season of Docs est de donner aux rédacteurs techniques l'occasion de s'impliquer dans les 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 de ce point de vue. 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 ?
Faites attention à la conception et à la mise en page du document. Vérifiez la mise en page générale de l'un ou des exemples de documents. La conception est-elle logique ? Pouvez-vous facilement vous repérer dans le document ou le lot de documentation ? Y a-t-il des contenus en double ou existe-t-il des lacunes évidentes ?