architecture-decision
java
architecture-decision | java | |
---|---|---|
5 | 34 | |
- | 967 | |
- | 2.2% | |
- | 8.8 | |
- | 6 days ago | |
Java | ||
- | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
architecture-decision
-
Show HN: Architecture Decision Record – Spanish Tranlsations
Link is https://github.com/joelparkerhenderson/architecture-decision...
-
Architecture diagrams enable better conversations
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:
-
Polar v1.0: Let’s Fix Open Source Funding
If anyone wants to see Polar in action on a GitHub issue, I'm experimenting with Polar on my Architecture Decision Record repo:
https://github.com/joelparkerhenderson/architecture-decision...
(I'm on the fence about the value of Polar for this kind of issue... see what you think)
-
A Simple Framework for Architectural Decisions
Architecture Decision Records are a big help for teamwork. I have a bunch of notes and examples here, including from my time at ThoughtWorks with technology radars.
https://github.com/joelparkerhenderson/architecture-decision...
-
How boring should your team be
The article mentions Architectural Design Records (ADR) which can be included as a folder in the git repo for the project, as a means of documenting the historical decisions that led to the project's current structure. Some of that seems overly complex or formalized (i.e. reinventing UML and all the problems that came with it), but having that history in some kind of constant format would likely help overcome any novelty issues and help people grasp what's going on. The simplest format discussed seems the best for most cases:
https://github.com/joelparkerhenderson/architecture-decision...
java
-
Documentation as Code for Cloud - C4 Model & Structurizr
Structurizr is used for describing and visualizing architecture using the C4 model. One of the main selling points is the fact you can define an entire (IT) architecture model using text. A typical model consists of:
-
Architecture diagrams enable better conversations
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.
- Dynamically generate Cloud System Architecture diagram
-
Mastering Software Architecture Visualization with the C4 Model
Structurizr, available at https://structurizr.com/ and also has a free plan available with a single workspace available, is a tool that allows you to build out a C4 model using its Structurizr DSL to outline the Containers, Components, and Contexts of the architecture. It is a valuable tool for designing and visualizing a software architecture. In this example we'll build out a simple Machine Learning Pipeline, I mean a very basic one, featuring an ETL Pipeline and a model that trains images that classifies it as a image of planet earth or not. To begin, lets define our work space.
-
Top 9 software architecture tools
Structurizr builds upon "diagrams as code", allowing you to create multiple diagrams from a single model using a number of tools and programming languages.
- Architecture diagrams should be code
-
Launch HN: IcePanel (YC W23) – Onboard engineers with explorable system designs
As a customer since 2021, is this re-launch HN?
Loved the concept, found it fell over for real-sized things on even the most powerful machines, had to switch to Structurizr to do our C4 modeling: https://structurizr.com/
Was very disappointed, bet I'd get more devs to model architecture with this tool. If it's relaunching because perf problems were resolved, will look forward to try it again.
Depending on scope of people's needs, either highly recommended or, try it first.
Hats off to Victor for great support back then, and I see the docs are a reflection of that, like this section on embedding into popular tools:
https://docs.icepanel.io/features/sharing#embedding-share-li...
TL;DR: Helpful team, thoughtful UI, thoughtful docs, a product capability (c4 modeling) very worth understanding and using.
-
Keep your diagrams updated with continuous delivery
He built a tool called Structurizr for this.
-
D2 is now open source – a new, modern language that turns text to diagrams
Ah this is like https://structurizr.com which is based on C4.
- What tools do you use to map out microservices?
What are some alternatives?
structurizr-site-generatr - Static site generator for architecture models created with Structurizr DSL
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
architecture_decision_record - Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation
dsl - Structurizr DSL
exploring-the-testing-hyperpyramid - Code repo for the KotlinConf 2023 talk by @daviddenton and @s4nchez
c4-draw.io - Draw.io template/diagram containing C4 Model shapes. Drawio Diagrams.net
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
emacs-drawio
polar - From first donation to IPO. Polar is the funding & monetization platform for developers.
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
rfcs - Specifications for Interledger and related protocols
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams