Willem Van den Ende - WritingJun 14, 2024
Amazing (should not be) how much difference a bit of #LivingDocumentation makes. Wiring up a few 'micro' services. Had an integration test ( #NotAScam ;-) ). Generated a folder with request /response pairs (json, pretty printed) for each example, and each part of the flow.
Including the vintage computation that is at the heart of it. Yes, there are things wrong, but _we can all see they are wrong_ and have conversation about it 😃
JaapioApr 18, 2024

On May 30, I will talk about dead #documentation, and how to bring your docs alive. Are you joining me and become Dr Frankenstein?

#meetup, #LivingDocumentation

https://www.meetup.com/brabantphp/events/300465423/

Meetup in Tilburg with two talks: Living Documentation and Git worktrees, Thu, May 30, 2024, 7:00 PM | Meetup

We would like to welcome you for our next BrabantPHP meetup. This meetup will take place in **Tilburg at Scrumble**. Starting time: **19:00** (with food). **Living Docume

Meetup
JaapioFeb 20, 2024
When practicing #ddd, you model the mind map of your domain experts in your classes of the application domain. So why not build a glossary out of those classes and their description to help you talk about the domain? #LivingDocumentation
JaapioJan 23, 2024

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!

Show threadJaapioJan 13, 2024

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

JaapioDec 30, 2023

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:

#php #LivingDocumentation

Infinite State MachineJun 23, 2023

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.

#SoftwareDocumentation #LivingDocumentation #AITools

DiagramGPT – Powered by Eraser

Generate technical diagrams from code or plain language prompts. Diagrams powered by Eraser.

Guillaume LoursNov 20, 2019

Rhooo cette star le @[email protected] 😍

RT @[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

Le Singe Cuivre on Twitter

“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”

Twitter