Inspired by @sebastian at DPC, where he talked about "From events to insights" I prototyped something based on symfony messenger to collect saga (series of events) in my team's codebase.
The insights I got were very helpful to review our architecture. While the idea of #livingDocumentation isn't new to me. I never realized I was already so close to a working concept.
Thanks for your talk @sebastian
For people who want to see the talk:
https://youtu.be/CySblzGly_U
Your documentation is outdated the moment you write it. Unless it writes itself.
Antonio Alvino's Ignite at DevOpsDays Zürich 2026: why living documentation is cool.
It connects business with development, encourages ubiquitous language, and motivates Acceptance Test Driven Development. Nearly free, always current.
https://www.devopsdays.ch/event/program/ignites/antonio-alvino/
On May 30, I will talk about dead #documentation, and how to bring your docs alive. Are you joining me and become Dr Frankenstein?
I really enjoyed building a prototype of a new feature in @phpdoc, in this case it was back on my list because of a question I got.
Not that I would develop just any random feature by request... but this was on my list for a long time.
From now on, phpdoc will have automatically generated uml diagrams based on your project.
For me, this a huge step forward towards a goal, making #LivingDocumentation a thing in #php
Thanks @dgoosens for your question, that confirmed the need for this!
Continue the story... Imagine you are writing docblocks but want to make the description part of a larger story. With the next version of @phpdoc you will be able to turn your docblocks into chapters of your documentation.
I think this allows us to reinvent the way we can use docblocks to document our work. Inline and easy to edit together with your code.
#LivingDocumentation
When writing documentation about your application I find my self creating lists of classes. Opening up my editor, and search for all implementations of classes that extend a base class.
So why would we not just automate this shit? @phpdoc next release will have the first draft implementation for this feature.
Write your documentation in RsT and query the api docs to create a list:
DiagramGPT - https://www.eraser.io/diagramgpt
I was sceptical regarding the DiagramGPT tool, but I made some experiments - free text, docker compose file, source code in multiple program languages. And it just works. And it has an API, making generating living documentation even simpler.
Rhooo cette star le @[email protected] 😍
Comment favoriser l’accélération des rythmes de transformations visées en #ContinuousDelivery, #DevOps et approches #Agiles ?
#LivingDocumentation: @[email protected] nous partage ses bonnes pratiques pour que le transfert et la conservation du savoir portent leurs fruits. #dédicace #livre
🐦🔗: https://twitter.com/lesingecuivre/status/1197199744638095364
“Comment favoriser l’accélération des rythmes de transformations visées en #ContinuousDelivery, #DevOps et approches #Agiles ? #LivingDocumentation: @cyriux nous partage ses bonnes pratiques pour que le transfert et la conservation du savoir portent leurs fruits. #dédicace #livre”
Jaapio
DevOpsDays Zurich
Willem Van den Ende - Writing
Infinite State Machine
Guillaume Lours