Architecture diagrams enable better conversations

1. asciiflow

   1 55 5,007 6.9 TypeScript

   ASCIIFlow

   

   The only 2 techs I use for stuff like that are

   Asciiflow https://asciiflow.com/#/

2. InfluxDB

   influxdata.com featured

   InfluxDB high-performance time series database. Collect, organize, and act on massive volumes of high-resolution data to power real-time intelligent systems.

   

3. architecture_decision_record

   2 27 13,163 6.6

   Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation

   

   Hi, article author here, we supplement our architecture diagrams with Architectural Decision Records (ADRs) https://github.com/joelparkerhenderson/architecture-decision... in the ADR we capture:

4. architecture-decision

   3 5 - -

   Hi, article author here, we supplement our architecture diagrams with Architectural Decision Records (ADRs) https://github.com/joelparkerhenderson/architecture-decision... in the ADR we capture:

5. exploring-the-testing-hyperpyramid

   4 2 15 3.7 Kotlin

   Code repo for the KotlinConf 2023 talk by @daviddenton and @s4nchez

   

   Http4k, a http library for Kotlin, has an, in my opinion, great way of generating documentation for you [0]. They explain it in more detail in their talk [1] and also have an example repository [2], if you favor to look at code.

   [0] https://www.http4k.org/blog/http4k_v5/#tracerbullet_a_brand_...

   [1] https://www.youtube.com/watch?v=CrslqbMbaD8

   [2] https://github.com/http4k/exploring-the-testing-hyperpyramid

6. java

   5 34 1,053 9.0 Java

   Structurizr for Java (by structurizr)

   

   I've been using https://structurizr.com/ to automatically generate C4 diagrams from a model (rather than drawing them by hand). It works well with the approach for written documentation as proposed in https://arc42.org/. It's very easy to embed a C4 diagram into a markdown document.

   The result is a set of documents and diagrams under version control that can be rendered using the structurizr documentation server (for interactive diagrams and indexed search).

   I also use https://d2lang.com/ for declarative diagrams in addition to C4, e.g., sequence diagrams and https://adr.github.io/ for architectural decision records. These are also well integrated into structurizr.

7. d2

   6 99 20,434 9.8 JavaScript

   D2 is a modern diagram scripting language that turns text to diagrams.

   

   I've been using https://structurizr.com/ to automatically generate C4 diagrams from a model (rather than drawing them by hand). It works well with the approach for written documentation as proposed in https://arc42.org/. It's very easy to embed a C4 diagram into a markdown document.

   The result is a set of documents and diagrams under version control that can be rendered using the structurizr documentation server (for interactive diagrams and indexed search).

   I also use https://d2lang.com/ for declarative diagrams in addition to C4, e.g., sequence diagrams and https://adr.github.io/ for architectural decision records. These are also well integrated into structurizr.

8. arc42.org-site

   7 16 6 8.1 SCSS

   (jekyll-based) website for arc42.org - the template for communicating software architectures.

   

   I've been using https://structurizr.com/ to automatically generate C4 diagrams from a model (rather than drawing them by hand). It works well with the approach for written documentation as proposed in https://arc42.org/. It's very easy to embed a C4 diagram into a markdown document.

   The result is a set of documents and diagrams under version control that can be rendered using the structurizr documentation server (for interactive diagrams and indexed search).

   I also use https://d2lang.com/ for declarative diagrams in addition to C4, e.g., sequence diagrams and https://adr.github.io/ for architectural decision records. These are also well integrated into structurizr.

9. CodeRabbit

   coderabbit.ai featured

   CodeRabbit: AI Code Reviews for Developers. Revolutionize your code reviews with AI. CodeRabbit offers PR summaries, code walkthroughs, 1-click suggestions, and AST-based analysis. Boost productivity and code quality across all major languages with each PR.

   

10. structurizr-site-generatr

    8 1 267 9.1 Kotlin

    Static site generator for architecture models created with Structurizr DSL

    

    Recently been doing the same amongst our various teams since we have a mish-mash of Lucidchart, Miro, and other collaborative design tools.

    One thing I was experimenting with (read: struggling with!) was a way to keep per-service (per-repo) architecture workspaces which are also synchronized on-commit to a central workspace and used !include to bind them together. The moving parts are not difficult - but writing your DSLs in a way that can handle this can be. This idea would let individual projects be self-sufficient and generate their own README doc diagrams as part of their own build process; but also have a central site which shows all the services as well as inter-service connectivity.

    Did you ever consider https://github.com/avisi-cloud/structurizr-site-generatr to bring together your ADRs in with your architecture, or do you keep them separate?

11. c4-notation

    9 138 27 10.0

    Technical resources for using the C4 model for visualizing software architecture.

    

    You probably want https://c4model.com/ which explains what a C4 architecture diagram is. (See the first footnote in the article.)

12. Diagon

    10 8 1,910 5.3 C++

    Interactive ASCII art diagram generators. :star2:

    

    A few more ASCII-based tool that you could add into your workflow are https://arthursonzogni.com/Diagon/#Sequence which can be used to generate the ASCII that you input into something like Typogram (https://google.github.io/typograms/).

    For example, input:

      Renderer -> Browser: BeginNavigation()

Suggest a related project