Série "Make documentation great again"

Qui aime rédiger la documentation de son produit ou de son API ? Qui en a marre de trouver des documentations obsolètes en arrivant sur un projet ?
Tu es développeur et tu te sens concerné ? Il est temps de passer à la "Documentation as Code" !

Il est de coutume de documenter l’API que l’on développe, pour faciliter sa maintenance et les interactions avec ses "consommateurs".
Même si l’une des 4 valeurs de l’agilité promeut "un logiciel fonctionnel plutôt qu’une documentation exhaustive", nous allons voir que l’on peut proposer les deux en même temps grâce à un outil particulièrement pratique.

Les 3 articles de cette série :

Make documentation great again (1/2)

Make documentation great again (1/2)

Qui aime rédiger la documentation de son produit ou de son API ? Qui en a marre de trouver des documentations obsolètes en arrivant sur un projet ? Il est temps de passer à la "Documentation as code" !

Lire la suite...
Make documentation great again (2/2)

Make documentation great again (2/2)

L'une des valeurs de l'agilité est "un logiciel fonctionnel plutôt qu’une documentation exhaustive" ... et si on faisait les deux ?!

Lire la suite...
Make documentation great again (Bonus)

Make documentation great again (Bonus)

Après la présentation générale de Spring REST Docs, je vous propose d'aller un peu plus loin en nous penchant sur des petites améliorations qui feront toute la différence !

Lire la suite...