Phase actuelle:
Le programme Saison 2021 de Docs s'est terminé le 14 décembre 2021. Consultez le calendrier.
Cette page contient des conseils destinés aux organisations Open Source pour évaluer et sélectionner le bon rédacteur technique pour leur proposition de projet Season of Docs.
Introduction
Les organisations Open Source doivent embaucher un rédacteur technique pour travailler sur le projet proposé. Les entreprises doivent se procurer leur propre rédacteur technique. Les rédacteurs techniques qui souhaitent travailler avec des organisations participant à Season of Docs peuvent trouver leur nom dans le dépôt GitHub Season of Docs et sur la chaîne#season-of-docs dans le Slack "Write the Docs".
Évaluation d'un rédacteur technique
Nous vous recommandons de demander aux rédacteurs techniques que vous envisagez de formuler des exemples de documentation précédemment développée afin de pouvoir vous concentrer sur l'évaluation de leurs compétences et de leur expérience de rédaction technique.
Expérience et compétences en rédaction technique
Examinez l'expérience antérieure du rédacteur technique. Dans l'idéal, le rédacteur technique doit avoir une expérience préalable de la rédaction de documentation technique pour l'industrie logicielle. L'un des objectifs de Season of Docs est de donner aux rédacteurs techniques la possibilité de s'impliquer dans des produits destinés aux développeurs. Pour cette raison, il n'est pas essentiel que le rédacteur connaisse 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 le langage et les compétences en communication. Évaluer le travail précédent du rédacteur technique de ce point de vue. Le plus important: comprenez ce que la personne a écrit ? Si vous souhaitez un examen approfondi de la formulation du texte du rédacteur technique, recherchez la cohérence au niveau de la ponctuation et de la formulation, l'orthographe et la clarté. La formulation est-elle simple ou compliquée ? Les phrases sont-elles courtes ou s’étendent-elles jusqu’à ce qu’elles deviennent difficiles à suivre ?
Faites 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 l'ensemble de documentation ? Y a-t-il des contenus en double ou des lacunes évidentes ?