Phase actuelle:
annonce des résultats dans le calendrier.
Cette page contient des conseils destinés aux organisations Open Source pour évaluer et sélectionner le rédacteur technique approprié pour leur proposition de projet Season of Docs.
Introduction
Les organisations Open Source doivent engager un rédacteur technique pour travailler sur le projet proposé. Les entreprises doivent faire appel à leur propre rédacteur technique. Les rédacteurs techniques qui souhaitent travailler avec des organisations participant à Season of Docs se trouvent dans le dépôt GitHub Season of Docs et sur la chaîne#SEASON-of-docs dans le Slack "Write the Docs".
Début du processus
Nous vous recommandons de rechercher un rédacteur technique dès que vous pensez pouvoir participer à Season of Docs.
Évaluation d'un rédacteur technique
Nous vous recommandons de demander aux rédacteurs techniques que vous envisagez d'utiliser des exemples de documentation déjà développées afin de pouvoir vous concentrer sur l'évaluation de leurs compétences et de leur expérience en matière de rédaction technique.
Compétences et expérience 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 documentations techniques pour le secteur du logiciel. 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 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 le travail antérieur 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 profondeur la langue utilisée dans le travail du rédacteur technique, recherchez la cohérence dans la ponctuation et la formulation, l'orthographe et la clarté du texte. La formulation est-elle simple ou compliquée ? Les phrases sont-elles courtes ou continuent-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 du ou 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 ?
Embaucher un rédacteur technique
Les organisations doivent engager un rédacteur technique et remplir le formulaire de recrutement de justificatif de rédacteur technique dont le lien figure ci-dessous d'ici le 16 mai 2022 à 18h (UTC).
Phase de recrutement du rédacteur technique terminée.
Avant de procéder à l'embauche, veillez à discuter de la compensation et d'un échéancier des paiements avec le rédacteur technique. Nous recommandons aux organisations de créer un échéancier des paiements avec les rédacteurs techniques en fonction des jalons du projet, y compris un paiement au lancement du projet. Tenez compte des dates de paiement, qui n'interviennent que deux fois au cours du programme, et des montants lorsque vous créez un échéancier des paiements.
Remarque : Les organisations qui n'ont pas engagé de rédacteur technique et qui n'ont pas envoyé le formulaire de preuve du recrutement de rédacteur technique au plus tard le 16 mai 2022 à 18h UTC ne recevront pas de fonds à la date du premier versement.