Documentation : C'est une bonne position ça, Scribe ?
26 octobre 2021 · 1 h 08
« Pas de doc, pas de feature. »
— Sarah Haïm-LubczanskiLes versions de cet épisode
Un épisode vit en plusieurs temps : la source, sa version compilée par un autre invité quelques semaines plus tard, puis son refactoring quelques années après.
De quoi on parle
La D.E.V. de la semaine est Sarah Haïm-Lubczanski, Documentation Architect. Sarah vient nous parler de son métier, bien sûr, et aussi de la doc. Cet élément étrange que nous réclamons tous, de différentes façons, mais que personne ne veut faire. Sarah nous donne son avis sur ce qu’est une bonne documentation (et cela inclut les commentaires dans votre code), qui devrait écrire la doc (je ne spoil pas, mais vous devriez écouter l’épisode), quand faire la doc, et aussi comment faire la doc !
Cité dans l'épisode
Ranger votre doc : Framework de documentation Diataxis.fr
La doc de la doc, et la communauté de Documentarians : Write The Docs
Un exemple : La doc d'API de Stripe
Gitlab a publié son onboarding