Phase actuelle:
Résultats annoncés. Consultez la chronologie.
Voici quelques consignes pour aider les organisations Open Source à travailler efficacement avec des rédacteurs techniques.
Présentez-lui le monde de l'open source et votre communauté.
- Faites une "visite guidée" de votre communauté au rédacteur technique. Où peuvent-ils poser des questions ? À quelles réunions régulières doit-il participer ou à quelles listes de diffusion doit-il participer ? De quels comptes ont-ils besoin (Github, Discord, Slack) ? Assurez-vous qu'ils comprennent le code de conduite de votre projet et savent comment signaler tout problème. Assurez-vous que votre rédacteur technique a compris la licence de votre projet et qu'il respecte toutes les exigences des autres employeurs concernant la signature d'accords de licence pour les contributeurs, des APD ou d'autres accords.
- Si possible, présentez-leur quelques personnes dont les fuseaux horaires se chevauchent, qui pourront répondre rapidement aux questions concernant la communauté ou le projet.
- Si possible, envoyez-lui des goodies du projet.
Aidez le rédacteur technique à utiliser les outils et les processus nécessaires pour contribuer à votre projet.
- Si vos processus ne sont pas bien documentés, prévoyez un rendez-vous pour présenter au rédacteur technique sa première contribution, son premier problème ou sa première demande de tirage. Quels modèles ou balises doit-elle utiliser ? Qui doit examiner sa contribution, et comment et quand doit-il effectuer le suivi des avis ? Si son travail inclut des exemples de code, comment les tester ? Que doit-il savoir sur votre processus ou vos versions CI/CD ?
Aidez 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 compréhension conceptuelle solide du produit. Cela peut aider le rédacteur technique à se sentir plus confiant et à être plus autoritaire dans son écriture pour le projet.
- Décrivez les besoins des personnes qui utilisent le projet. Soyez aussi précis que possible. Ne dites pas simplement "développeurs", mais "développeurs créant des sites Web" et "développeurs programmant des robots industriels".
- Mettez le rédacteur technique en relation avec les experts nécessaires. Il s'agit des développeurs ou des autres contributeurs du projet responsables des aspects de votre projet que la documentation couvrira.
- Assurez-vous que le rédacteur technique dispose du temps et des ressources dont il a besoin de la part des experts du sujet et des autres membres de la communauté.
Posez des questions !
- Il est possible que votre communauté ou votre projet n'aient jamais travaillé avec des rédacteurs techniques ou des contributeurs à la documentation auparavant. Profitez de cette occasion pour apprendre tout en partageant vos connaissances. Demandez-lui son avis sur vos processus et vos outils. Il vous fera probablement des suggestions d'amélioration.