Damien Lucas
Damien Lucas , onepoint
Ayant commencé ma carrière dans le mainframe, je suis maintenant Tech Lead et Architecte Logiciel Java depuis plusieurs années. J'adore lire la doc avant de me lancer dans le code. Et par dessus tout, j'aime échanger et transmettre sur ce que j'ai pu apprendre de mes expériences, des discussions avec mes pairs, des conférences vues ...
La doc va bien, ne t'en fais pas
RTFM (abbréviation, péjoratif)
- Exprime le manque de recherches sur un sujet.
Relis Ton Fichu Manuel, qui n'a jamais prononcé ou entendu ce doux acronyme dans un open space ? Même si cette injonction est louable, encore faut-il avoir de la documentation à lire!
Syndrôme de la page blanche ? Que faut-il documenter ? Comment structurer ma documentation ? Et mes schémas ?
Trop de questions qui, mises bout à bout, nous empêche de faire le premier pas.
Dans ce talk, je vous ferai part de mes expériences sur l'utilisation de deux templates de structure de documentation : arc42 et Diátaxis. Rien de plus simple, il suffit de les remplir!
Je vous montrerai ensuite des outils open source permettant de générer du contenu sans effort supplémentaire. A commencer par des outils de génération de diagrammes (PlantUML, draw.io, mermaid), puis des outils de modélisation (C4, structurizr). Enfin, des outils de génération de documentation : schemaSpy pour documenter votre base de données, springdoc pour vos API REST et Compodoc pour vos frontends.