exploring-the-testing-hyperpyramid
c4-notation
exploring-the-testing-hyperpyramid | c4-notation | |
---|---|---|
2 | 126 | |
11 | 25 | |
- | - | |
5.4 | 10.0 | |
about 2 months ago | almost 5 years ago | |
Kotlin | ||
- | 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.
exploring-the-testing-hyperpyramid
-
Architecture diagrams enable better conversations
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
-
http4k at KotlinConf '23: Exploring the Testing Hyperpyramid. aka: Auto-generation of visual documentation from tests
There is also a companion GitHub repo where you can find all of the code.
c4-notation
-
Ask HN: Guidelines for making clear architecture diagrams
Second this.
Reference for anyone looking I to it: https://c4model.com/
There is also quite a lot of options for helping create these diagrams. I've found https://structurizr.com/ to be the best of what I've tried so far.
-
Show HN: Flyde – an open-source visual programming language
What you are describing sounds a lot like C4: https://c4model.com/
-
Ask HN: How do you document complex software systems?
The C4 model [0] provides a mostly sensible structure and techniques for representing pure software systems across different abstraction levels.
For systems involving software and hardware, or other complex interfacing (both technology and bureaucracy) this starts to delve into the universe of systems engineering. There's a decent assembly of knowledge on that in the SEBoK [1].
As another commenter has already called out too, one of the most valuable sources of information is also _why_ a system is in its current form and _how_ that's changed over time. ADR's [2] really do a good job at nailing this for just about any scale.
[0]: https://c4model.com
[1]: https://sebokwiki.org
[2]: https://adr.github.io
-
A View on Functional Software Architecture
There a various standards for documenting software architecture, like arc42 or C4. While useful and somewhat well-known (there is certainly a correlation here), here architecture documentation can be further simplified, particularly due to the self-similarity of project and component. Following is a small template, that can also serve as a project's and component's README:
- The C4 model for visualising software architecture
-
Inkscape Cloud Architect
I would suggest that if your architecture diagrams are a bunch of icons provided by AWS/Azure/GCP with lines pointing at each other... you are doing it wrong.
The 'what does this box do for my system' is vastly more important than the 'which in vogue offering from my cloud provider implements it'.
I highly suggest folks take a look at the C4 Model: https://c4model.com/
- What do you wish business folks knew about UML?
-
How to create interactive zoomable software architecture diagrams
We often use abstractions in software engineering to communicate complex architectures and software systems. In this article, we’ll discuss how abstractions are inherently hierarchical and how the C4 model provides a nested structure for defining your software architecture. We’ll then cover how IcePanel allows you to create interactive and zoomable diagrams for your audience to zoom in and out of different levels of technical detail.
-
Architecture diagrams enable better conversations
You probably want https://c4model.com/ which explains what a C4 architecture diagram is. (See the first footnote in the article.)
What are some alternatives?
architecture-decision
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
backstage - Backstage is an open platform for building developer portals
java - Structurizr for Java
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
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
pumla - pumla - systematic re-use of model elements described with PlantUML
Diagon - Interactive ASCII art diagram generators. :star2:
plantuml - Generate diagrams from textual description