Phase actuelle:
annonce des résultats dans le calendrier.
Voici quelques conseils pour aider les organisations Open Source à travailler efficacement avec des rédacteurs techniques.
Présentez le rédacteur technique au monde de l'Open Source et à votre communauté
- Proposez au rédacteur technique une "visite guidée" de votre communauté. Où peut-il poser des questions ? À quelles réunions régulières devrait-il participer ou à quelles listes de diffusion doit-il participer ? De quels comptes a-t-elle besoin (GitHub, Discord, Slack) ? Assurez-vous qu'ils comprennent le code de conduite de votre projet et qu'ils savent comment signaler les problèmes. Assurez-vous que votre rédacteur technique comprend la licence de votre projet et respecte toutes les exigences des autres employeurs concernant la signature des CLC, des DCO ou d'autres accords.
- Si possible, présentez-les à des personnes situées dans des fuseaux horaires qui se chevauchent afin de pouvoir répondre rapidement aux questions sur la communauté ou le projet.
- Si vous le pouvez, envoyez-leur des goodies.
Aider le rédacteur technique à utiliser les outils et processus impliqués dans la contribution à votre projet
- Si vos processus ne sont pas bien documentés, fixez un moment pour guider le rédacteur technique dans sa première contribution, son premier problème ou sa première demande d'extraction. Quels modèles ou balises doit-il utiliser ? Qui doit examiner sa contribution, et comment et quand doit-il assurer le suivi des avis ? Si son travail comprend des exemples de code, comment peuvent-ils être testés ? Qu'a-t-elle besoin de savoir sur vos versions ou processus CI/CD ?
Aider le rédacteur technique à comprendre votre projet et ses utilisateurs
- Expliquez votre projet en détail afin que le rédacteur technique acquière une solide compréhension conceptuelle du produit. Cela peut aider le rédacteur technique à se sentir plus confiant et à faire plus autorité dans sa rédaction du projet.
- Décrire les besoins des personnes qui utilisent le projet. Soyez aussi précis que possible : pas seulement des "développeurs", mais aussi des "développeurs qui créent des sites Web" et "développeurs de robots industriels".
- Mettre le rédacteur technique en contact avec les experts en la matière nécessaires. C'est-à-dire les développeurs ou autres contributeurs au projet responsables des aspects de votre projet couverts par la documentation.
- Assurez-vous que le rédacteur technique dispose du temps et des ressources nécessaires de la part des experts en la matière et de tous les autres membres de la communauté.
Posez des questions !
- Il est possible que votre communauté ou votre projet n'ait jamais travaillé avec des rédacteurs techniques ou des contributeurs à la documentation auparavant. Profitez-en pour apprendre tout en partageant vos connaissances ! Demandez des commentaires sur vos processus et outils. Votre rédacteur technique aura probablement des suggestions d'amélioration.