La doc va bien, ne t'en fais pas

Ce talk aborde l'importance de la documentation technique, comment la structurer et la versionner. Il partage des expériences sur l'utilisation de modèles et d'outils open source pour générer du contenu. Parmi les sujets abordés : les templates de structure, outils de génération de diagrammes et de documentation.

Damien Lucasonepoint

talkDetail.whenAndWhere

Wednesday, April 17, 11:35-12:20

Maillot

talks.description

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!
Mais par où commencer ? Que faut-il documenter ? Comment structurer ma documentation ? La versionner ? 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 templates de documentation et sur les outils open source permettant de générer du contenu sans effort supplémentaire. Nous aborderons :

Des templates de structure de documentation (arc42, Diátaxis)
Outils de génération de diagrammes (PlantUML, draw.io, mermaid)
Outils de modélisation (C4, structurizr)
Outils de génération de documentation (schemaSpy, springdoc, Compodoc)
Outils de publication (publisherConfluence, wiki, site statique)

generation

architecture

tools

documentation

talks.speakers

Damien Lucas

onepoint

France

Ayant commencé ma carrière dans le mainframe, je suis maintenant développeur et Tech Lead 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 ...

comments.title

comments.speakerNotEnabledComments