3 raisons d’héberger un docathon pour votre projet open source

La documentation de votre projet open source est essentielle pour vos clients. Votre public cible doit comprendre le but de votre projet et comment l’utiliser, et la documentation est ce qui comble cet écart. Un projet est rarement vraiment terminé, il est donc tout aussi important que les ressources soient maintenues et mises à jour avec l’amélioration continue de votre projet.

Mais que se passe-t-il lorsque vous avez beaucoup de documentation à maintenir mais que vous manquez de ressources pour la tenir à jour ? La réponse est assez simple : organisez un docathon !

Qu’est-ce qu’un docathon ?

Un docathon est comme un hackathon. Un hackathon est un événement où les ingénieurs et les leaders de la communauté se réunissent pour améliorer ou ajouter de nouvelles fonctionnalités à une application existante. Dans un docathon, le même type de collaboration porte sur l’amélioration de la documentation.

[ Learn about writing Docs as Code. ]

Un docathon peut combler des lacunes dans le contenu, restructurer de grands ensembles de documentation, réparer des liens brisés ou simplement corriger des fautes de frappe. L’intention derrière l’hébergement d’un docathon est d’améliorer une grande quantité de documentation dans un délai relativement court.

Voici quelques exemples de documentation produit :

• Manuels de formation
• Manuels d’utilisation
• Guides d’installation
• Guides de dépannage
• Guides de démarrage rapide
• API Documentation
• Tutoriels

Dans mon organisation, notre équipe de documentation a organisé un docathon et a remanié avec succès un guide d’installation de 102 pages. Le docathon nous a permis de nous concentrer sur le périmètre du projet, qui était de se réorganiser pour plus de simplicité, de supprimer les contenus dupliqués et de suivre le parcours client. L’organisation d’un docathon a laissé une impression durable sur mon équipe et a amélioré le succès des clients.

[ Read Write documentation that actually works for your community ]

3 choses que vous pouvez réaliser avec un docathon

Voici mes trois principales raisons d’organiser un docathon :

1. Plus de retard

La plupart des documentations doivent évoluer avec le produit qu’elles prennent en charge. Au fur et à mesure que le produit change ou se met à jour, la documentation doit en faire autant. Dans certains cas, les équipes de documentation publient de nouvelles versions de leur documentation parallèlement au cycle de publication de l’équipe d’ingénierie. Au fur et à mesure que les priorités au sein d’une équipe changent et que les versions GA se poursuivent, les équipes de documentation sont confrontées au défi de suivre les nouvelles fonctionnalités, les corrections de bogues et les tâches à accomplir. Les modifications qui restent font partie d’un backlog, une accumulation de travail qui doit être complété ultérieurement.

Conseil Docathon : Au cours d’un docathon, les participants peuvent trier les éléments du backlog et les compléter au fur et à mesure de leur progression dans la liste. Les participants non techniques peuvent travailler sur des correctifs liés aux fautes de frappe, aux liens brisés et à d’autres problèmes liés au texte.

2. Refonte des guides à grande échelle

Au moment où votre équipe de documentation se rend compte qu’il est temps de réorganiser un guide, il contient probablement plusieurs chapitres et des centaines de pages. Une fois le plan de contenu élaboré, la complexité de la restructuration commence. La restructuration d’une grande quantité de documentation n’est pas pour les faibles de cœur.

Conseil Docathon : Constituez une équipe pour diriger le docathon et offrez des incitations à la participation de différentes équipes ou départements à l’échelle de l’organisation. Selon l’étendue du travail et les contraintes de temps, votre équipe peut restructurer avec succès un guide entier en moins de temps que prévu.

3. Collaboration entre équipes interfonctionnelles

Il est courant que différents groupes au sein d’une organisation travaillent de manière isolée. Les équipes d’ingénierie, de produit, de support client, de marketing et de documentation peuvent ne pas collaborer sur des projets aussi souvent qu’elles le devraient.

Imaginez organiser un événement où chaque membre de l’équipe peut utiliser son expertise pour améliorer la documentation du produit. Les docatons favorisent la diversité des experts en la matière (PME), la collaboration en temps réel et la communication. Ils permettent également un environnement inclusif où les personnes résidant dans différents lieux géographiques peuvent participer en personne ou à distance. Votre documentation reçoit toute l’attention d’experts avec différents points de vue et spécialisations, minimisant les silos isolés, les préjugés inconscients et l’épuisement professionnel.

Conseil Docathon : Permettre à des équipes interfonctionnelles de se rassembler pour une cause commune.

[ Learn what it takes to build a resilient IT culture ]

Marathon documentaire

La prochaine fois que votre équipe a un arriéré apparemment insurmontable ou est chargée de restructurer un énorme projet de documentation, envisagez d’organiser un docathon. C’est facile, et sa productivité peut vous surprendre. Pour plus d’informations sur l’organisation d’un événement comme celui-ci, lisez l’excellent guide en 10 étapes de Tiffany Long pour organiser un hackathon.