architecture-decision
d2
architecture-decision | d2 | |
---|---|---|
5 | 92 | |
- | 15,867 | |
- | 1.6% | |
- | 9.7 | |
- | 10 days ago | |
Go | ||
- | Mozilla Public 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...
d2
- NMAP-formatter: convert NMAP results to HTML, CSV, JSON, graphviz (dot), SQLite
- Penrose – Penrose
-
Pikchr: A PIC-like markup language for diagrams in technical documentation
While not embedded in markdown, I like d2 [1]. I can use it with org-babel to embed and view the diagrams on emacs. After using graphviz for years, the visual output seems more polished to me. With that said, I want to give pikchr a try.
[1]:https://d2lang.com/
- Ask HN: How do you build diagrams for the web?
-
Documentation as Code for Cloud - C4 Model & Structurizr
In the next post I'll deep-dive into the D2 language which also has a huge set of features. Stay tuned.
- Inkscape Cloud Architect
-
Nomnoml
That site is created by the maintainers of D2[1], so it might be biased, but I still think D2 has the friendliest syntax of the bunch, including nomnoml.
[1]: https://d2lang.com/
- Software Architecture Tools
- D2: Declarative Diagramming
-
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.
What are some alternatives?
structurizr-site-generatr - Static site generator for architecture models created with Structurizr DSL
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
architecture_decision_record - Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
exploring-the-testing-hyperpyramid - Code repo for the KotlinConf 2023 talk by @daviddenton and @s4nchez
d3 - Bring data to life with SVG, Canvas and HTML. :bar_chart::chart_with_upwards_trend::tada:
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
Mermaid - Edit, preview and share mermaid charts/diagrams. New implementation of the live editor.
polar - Polar is the creator platform for developers & the open source ecosystem.
diagrams - :art: Diagram as Code for prototyping cloud system architectures
rfcs - Specifications for Interledger and related protocols
mermaid-cli - Command line tool for the Mermaid library