Mieux écrire, mieux trouver : Diátaxis appliqué à la doc de plateforme
Les infos pratiques
- la session a lieu en Amphi E le jeudi de 15h35 à 16h00
- La session est prévu avec un niveau Introduction
- La session aura pour thème : Méthodologie
Description
Bien documenter une plateforme interne, c’est essentiel… mais entre les contributions dispersées, les outils tiers déjà documentés, et les besoins variés des utilisateurs, structurer cette documentation devient vite un casse-tête. Heureusement, Diátaxis (https://diataxis.fr/) est venu à notre rescousse ! Chez PayFit, nous avons décidé de refondre entièrement la documentation de notre plateforme interne en adoptant cette méthodologie, avec un parti pris : organiser chaque section (Tutoriels, How-To, Explications, Reference) autour des cas d’usage de la plateforme pour une approche 100% developer-centric. Le résultat ? De nombreuses identifications de doublons de documentation (!), une contribution plus fluide, une identification plus aisée des éléments manquants, et une meilleure navigation pour les utilisateurs de notre plateforme interne. De la méthode Diátaxis en elle-même à la solution de rendu (du bon vieux mkdocs ? Un developer portal ? Un site dédié basé sur Astro/Starfish ?), en passant par quelque tips pour rendre la contribution à la doc moins rébarbative, ce talk vous donnera des clés actionnables pour rentre votre documentation plus utile et efficace !
Orateur·ices
Alexis "Horgix" Chotard
Alexis "Horgix" Chotard is a systems engineer and developer working at PayFit (https://payfit.fr), a French unicorn. Developer by training with experience primarily focused on systems and infrastructure, naturally finding himself involved in all things "DevOps"'. Passionate about automation to build autonomous, resilient, and easily maintainable systems. Committed to the Cloud Native ecosystem, lover of Rust, and supporter of open source.