July 26th, 2024

Show HN: Create diagrams of complex data flows in software systems

The GitHub repository for the project `gg` is a lightweight software architecture simulator that allows users to visualize, document architectures, and create presentations. Users can clone the repository to get started.

Read original articleLink Icon
CuriositySkepticismEnthusiasm
Show HN: Create diagrams of complex data flows in software systems

The GitHub repository for the project `gg` is a lightweight software architecture simulator aimed at documentation and presentation. It enables users to visualize and document various software architectures while also serving as a tool for creating step-by-step presentations of different usage scenarios. Key features include software architecture simulation and presentation capabilities. To get started, users can clone the repository and execute the commands `npm install` and `npm run dev`. Examples of usage scenarios can be found on the project's website, including visualizations of the app's architecture and explanations of how Redux works. For further details, users are directed to the project's homepage at gg-charts.com.

AI: What people are saying
The comments on the `gg` project reveal a mix of appreciation and constructive criticism regarding its features and usability.
  • Users appreciate the clean design and functionality, with some expressing excitement about its potential for documentation and presentations.
  • There are concerns about the effectiveness of animated diagrams, with some suggesting that they may distract from the information being conveyed.
  • Several users request additional features, such as integration with existing tracing systems, text formats for diagrams, and export options for animated formats.
  • Some commenters highlight issues with the website's accessibility and functionality, noting problems with certificates and ISP blocks.
  • There is a desire for more demos and examples to better understand the tool's capabilities and applications.
Link Icon 24 comments
By @beardedwizard - 3 months
I love it, but I can't help but wonder why I almost never see complete or up to date diagrams in an enterprise or at scale software engineering setting, despite there being so many tools in this space (mermaid, uml, draw.io, graphviz, etc). I wonder what the barrier is or how to make tools like this fundamentally different so that we would see more adoption.

This comes up frequently in the context of secure design review, or more generally when outside stakeholders need to understand a foreign system.

Nobody argues against diagrams as good practice, but so few actually make them. That tells me incentives/costs are still off, despite good intent.

Information extraction from design docs could be one approach to suggest a diagram for free but that creates a dependency on the fidelity of the design document.

By @myrmidon - 3 months
This is pretty nice! Really like the choices for the Keyboard shortcuts and how they are presented.

My favorite tool for creating diagrams so far is still Drakon (try in browser: https://drakonhub.com/start-drakon).

It has the best "move element" behavior of any diagramming tool I've ever encountered (it shifts neighboring elements predictably, minimally and often in the exact way that I actually want).

gg-charts is pretty close in some respects, but still feels a bit more clunky to me, because the "move element" function gives less direct feedback, and in some cases complicates the layout more than I feel necessary.

By @tristanMatthias - 3 months
Love this. Would love to be able to: a) Pause b) Step through the individual steps (I see they're titled) c) Go back / Forward to grokk better
By @throwaway7ahgb - 3 months
Wishlist: Plug into existing tracing systems. Meaning if I use Datadog, I could use this to map my environment if I have tracing enabled.
By @kgilpin - 3 months
Is there a text format for this? I’d be interested in seeing if we can generate these from trace data the way that we do for sequence diagrams and flow charts.

https://appmap.io/docs/reference/navie.html#diagram

By @pfarrell - 3 months
Thanks for sharing your work. I too have the problems you’re attempting to address. Makes me think of LabView (which I would recommend checking out for inspiration if you’re unaware of it).
By @battered8310 - 3 months
This is pretty cool. I’ll definitely be following the development of this. I was just starting to look at how something similar could be done using mermaid.js or plantuml.
By @avikalp - 3 months
Wow, this looks very interesting. I saw the diagram of your own application and it looks more dynamic than the ones that I am generally used to at work.

I am curious about the motivation behind this project. What experiences triggered you to think that static diagrams are a problem?

Your answer will help me decide whether I'd like to use it for my own documentation or not.

By @bberenberg - 3 months
This is really great. However, I’d prefer this as a layer on top of an existing graphing library / syntax.
By @reacharavindh - 3 months
Reminds me of this old project..

https://netflixtechblog.com/vizceral-open-source-acc0c32113f...

I wish ^ were still alive. It was very cool and way ahead of its time.

By @stopthe - 3 months
Wow, I'm glad that I visited HN when your tool was at the top. I'm going to use it to illustrate docs on our internal DAG-like system. By the way, is there a simple way to export the animated diagram as a GIF?
By @Lucasoato - 3 months
The site doesn't work, I've tried reaching it from Amsterdam, Netherlands. First it raises an issue with the certificate, then it's blocked by the ISP. Very strange.
By @flarg - 3 months
In case any of you use draw.io note that you can animate lines with a right click. Last time I did this for a presentation I did have to record to gif but it worked really well.
By @phantomathkg - 3 months
When going to https://gg-charts.com all I got is a popup of 1 and displayed Hacked by NSF instead.
By @piyushtechsavy - 3 months
I really liked the UI and the ease with which diagrams can be created.Will it be possible to import diagrams from other tools like draw.io here.
By @acemarke - 3 months
As the author of that original Redux docs tutorial and data flow graph, happy to see it being used as an example here :)
By @alabhyajindal - 3 months
Very cool! Love how the links rearrange themselves when you move a node.
By @chj - 3 months
My laptop screamed after I played around in the redux demo. Must be something like infinite loop.
By @ilt - 3 months
Thanks for this! I love how minimal and intuitive it is.

Feature request - ability to export to Animated PNG!

By @BeefySwain - 3 months
I'd love to see more demos
By @Veuxdo - 3 months
Congrats on the launch. Looks very clean.

I think the core concept is flawed, though. "Animated diagrams" are great for generating engagement on social media, but in practice an animated line doesn't tell you anything an arrow wouldn't. They just become a distraction. Plus, they make it harder to read a label on the line (and "real" diagrams should have those).

By @mckn1ght - 3 months
I know you said you prefer the GUI over text-based, but that was the exact thing I wanted to ask for after trying your demo. GUI just doesn’t scale like text does. How will you be able to generate a diagram from code or a running process unless you have some intermediate textual representation? I assume you do anyways, at least implicitly, to save the state of your GUI’s output. You should bring that into focus. The GUI editor is simply a nonstarter for me. How do you compare the difference between two diagrams?

IMO the editing/sharing/maintenance experience of Mermaid’s sequence diagrams is nicer. What is your opinion on sequence diagrams in general? I much prefer their static nature and directional flow over animations you have to wait for when you need to review a detail you missed, and the top/down direction is better than trying to track points moving around in arbitrary directions.

By @diegoholiveira - 3 months
Super cool. Huge potential.