Aller au contenu
AFUP AFUP Day 2025 Baromètre Planète PHP PUFA
 

Utiliser un framework pour écrire de la documentation ?

Description

Et si il suffisait d'un peu de méthode et d'organisation pour que la doc devienne agréable à utiliser mais aussi à écrire ?

Au travers d'exemples culinaires simples à appréhender, nous verrons comment organiser sa documentation, comment mettre les auteurs en confiance, et comment écrire une documentation qui sera lue !

Le framework Diátaxis est encore peu connu mais il a déjà fait ses preuves chez de grands éditeurs de logiciels et j'ai eu l'occasion de le mettre en place dans une équipe technique de 60 personnes. Nous nous appuierons sur cette expérience pour montrer que la doc, ce n'est pas qu'une suite de mots et qu'on peut lui donner du sens.

Conférence donnée lors du Forum PHP 2024, ayant eu lieu les 10 et 11 octobre 2024.

Informations complémentaires

Le speaker

Martin SUPIOT

Staff Engineer chez Alma, Martin est passionné par le web et l'open-source depuis le siècle dernier. Impliqué au sein de l'AFUP et de l'antenne AFUP Nantaise ces dernières années, il ne rate pas une occasion d'échanger sur ces sujets, autour d'une bière belge de préférence !