RTFM (abbréviation, péjoratif)
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 :
- Exprime le manque de recherches sur un sujet.
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)
Damien Lucas
onepoint
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 ...
Français 
English