@@gui.ferreira that's the target, besides all the benefits you mentioned, for me I like the speed, it's easy and fast to create and update the diagrams
Hi Gui, thank you for this informative video. You mention in it something like "now we have documentation under control"... I would love to hear one of your videos expressing how you go about documenting your API systems nowadays. In my company we use SaFE as our agile framework and of course express customer needs in user stories to a feature and epic. But we still also need some kind of documentation where complete system is described so everyone doesn't need to search and find all the different user stories just to now why some business rule is needed etc. etc. So, again it would be super nice to hear your thoughts on documentation for modern API systems that your videos are about 🙏☺
That's the external search for traceability 😁 I've never seen that being done successfully. More often than not, it becomes a burden. Having said that, I believe the documentation you are looking for is Tests. Specifically, Acceptance Tests, and in that case, I would recommend checking TestRail or Xray.
I don't have experience with LaTeX. However, I would say that the advantages over PlantUML also apply here. Being widely used by common developer tools like GitHub, it's a competitive advantage.
@@gui.ferreira true. The fact that it is a dedicated tool might also be a great asset, it seems way more simple to understand way you look at the source, even if that mean sacrificing flexibility
Great video, I start using a few months ago, initially I was sceptic about it, but now, that's what I use for documentation.
Are you doing it in team documentation? Is it adopted by your all team?
@@gui.ferreira that's the target, besides all the benefits you mentioned, for me I like the speed, it's easy and fast to create and update the diagrams
Thank you for this very useful video!
Thank you 🙏
thank you very much! I've been struggling with diagrams😵💫
We all have been... We all...
Hi Gui, thank you for this informative video. You mention in it something like "now we have documentation under control"... I would love to hear one of your videos expressing how you go about documenting your API systems nowadays.
In my company we use SaFE as our agile framework and of course express customer needs in user stories to a feature and epic. But we still also need some kind of documentation where complete system is described so everyone doesn't need to search and find all the different user stories just to now why some business rule is needed etc. etc.
So, again it would be super nice to hear your thoughts on documentation for modern API systems that your videos are about 🙏☺
That's the external search for traceability 😁
I've never seen that being done successfully. More often than not, it becomes a burden.
Having said that, I believe the documentation you are looking for is Tests. Specifically, Acceptance Tests, and in that case, I would recommend checking TestRail or Xray.
@@gui.ferreira thanks, we will look at those products :)
Looks great and promising, I might try it for future projects. What major improvement do you think this adds to doing diagrams in LaTeX?
I don't have experience with LaTeX. However, I would say that the advantages over PlantUML also apply here.
Being widely used by common developer tools like GitHub, it's a competitive advantage.
@@gui.ferreira true. The fact that it is a dedicated tool might also be a great asset, it seems way more simple to understand way you look at the source, even if that mean sacrificing flexibility
@@valovanonym It's not a general-purpose tool. I would say you might lose some things in service of developer productivity.
@@gui.ferreira I do agree! It's nice that it is integrated to vscode
I use it in the tech docs for our current project.
It's an awesome tool. Do you have those documents in the repo?
@@gui.ferreira absolutely, yes. any software design docs go with the source files into the same repo and are version controlled together.
Which keyboard is on thumbnail?
Keychron K2 (Hot-swappable) 😉