Phase actuelle:
Développement de la documentation. Consultez le calendrier.
Voici quelques consignes pour aider les entreprises Open Source à travailler efficacement avec les rédacteurs techniques.
Présenter le rédacteur technique au monde de l'Open Source et à votre communauté
- Offrez 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-il besoin (GitHub, Discord, Slack) ? Assurez-vous qu'il comprend le code de conduite de votre projet et qu'il sait comment signaler tout problème. Assurez-vous que votre rédacteur technique comprend la licence de votre projet et qu'il respecte toutes les exigences d'autres employeurs concernant la signature de contrats de licence de niveau de service, d'OCD ou d'autres accords.
- Si possible, présentez-les à quelques 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 les processus impliqués dans la contribution à votre projet
- Si vos processus ne sont pas bien documentés, fixez un moment pour présenter au rédacteur technique 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 leur travail comprend des exemples de code, comment peuvent-ils être testés ? Qu'a-t-il besoin de savoir sur votre processus ou vos versions 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écrivez les besoins des personnes qui utilisent le projet. Soyez aussi précis que possible : pas seulement "développeurs", "développeurs créant des sites Web" et "développeurs de robots industriels".
- Mettre le rédacteur technique en contact avec les experts nécessaires en la matière. Autrement dit, les développeurs ou autres contributeurs au projet sont responsables des aspects de votre projet qui seront 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 des 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 de l'occasion d'apprendre tout en partageant ce que vous savez ! Demandez des commentaires sur vos processus et vos outils. Votre rédacteur technique aura probablement des suggestions d'amélioration.