Travailler avec un rédacteur technique

Phase actuelle:
Le programme Season of Docs 2019 s'est terminé le 6 mars 2020. Consultez la chronologie.

Voici quelques consignes destinées aux organisations Open Source pour collaborer avec un rédacteur technique que vous guidez pour Season of Docs:

  • Présentez le rédacteur technique au monde de l'Open Source et à votre communauté.
  • Aidez le rédacteur technique à utiliser les outils et les processus impliqués dans la contribution à votre projet.
  • Expliquez votre produit en détail afin que le rédacteur technique acquière une solide compréhension des concepts 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 de votre audience, c'est-à-dire ceux des développeurs qui utilisent votre produit et/ou d'autres groupes qui l'utilisent.
  • Ateliers sur les cas d'utilisation importants avec le rédacteur technique pour l'aider à concevoir la documentation requise
  • Parcourez le code lorsque le rédacteur technique doit le comprendre avant de rédiger les documents.
  • Mettre le rédacteur technique en contact avec les experts en la matière nécessaires. Autrement dit, les développeurs ou autres contributeurs au projet sont responsables des aspects de votre produit qui seront abordés dans 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é.
  • Collaborez avec le rédacteur technique pour ajouter des exemples de code pertinents aux documents, le cas échéant.

Points à retenir

Les mentors Open Source de Season of Docs ne sont pas nécessairement des rédacteurs techniques. Les mentors n'ont pas besoin d'avoir des compétences en documentation. Les rédacteurs techniques apportent ces compétences au projet et à la relation de mentorat.

Au lieu de cela, les mentors apportent leurs connaissances sur leur communauté Open Source, le produit, ainsi que les processus et les outils utilisés par le projet Open Source.

L'un des résultats importants de la relation de mentorat est que le rédacteur technique bénéficie d'une expérience enrichissante et fructueuse pour cette année de documents. Une expérience positive améliore les chances que le rédacteur technique continue de contribuer au projet Open Source après la fin de la saison des documents Google Docs de cette année, et que d'autres rédacteurs techniques deviennent enthousiastes à l'idée de travailler dans l'Open Source.