Wie man Software-Architekturdiagramme zeichnet (2022)

• Ein Artikel darüber, wie man effektive Software-Architekturdiagramme zeichnet
• Der Autor betont die Bedeutung von Diagrammen in der Softwareentwicklung; sie stehen oft im Mittelpunkt von Diskussionen und Entscheidungsfindung
• Der Inhalt eines Diagramms sollte korrekt, aktuell und eindeutig sein, und Entitäten sowie Beziehungen sollten präzise dargestellt werden
• Der Autor schlägt mehrere Merkmale effektiver Diagramme vor:
  • Minimierung der Nachbarschaftsdistanz: Wenn zusammengehörige Knoten nahe beieinander bleiben, lässt sich ein Diagramm leichter verstehen. Je größer das Diagramm wird, desto herausfordernder ist dies
  • Symmetrie finden: Symmetrische Diagramme sind ästhetisch ansprechend und leichter zu verstehen. Außerdem können sie die Aussage des Diagramms verstärken
  • Zentrierte Ausrichtung: Saubere und ausgerichtete Diagramme machen Konzepte klarer. Wenn bei jeder neuen Ergänzung die Ausrichtung beibehalten wird, bleibt das Diagramm ordentlich
  • Container-Gruppen verwenden: Wenn ein Diagramm in mehrere beschriftete Bereiche unterteilt wird, ist es leichter verständlich. Container können Kontext hinzufügen, Abstraktionen zeigen oder zusammengehörige Objekte gruppieren
• Der Autor kündigt an, in Teil 2 weiter auf Linienführung, Größe und Position von Labels, Farben, Icons und mehr einzugehen
• Dieser Artikel ist Teil des Terrastruct-Blogs, der Materialien für Softwareingenieure und Entwickler bereitstellt

[GN⁺]

Hacker-News-Kommentare

• Ein Nutzer erstellt aufgrund der Formatierungsoptionen und Syntax der D2-Sprache gern Diagramme und hat dazu einen Blogbeitrag geschrieben.
• VisualFlows.io wird bald v1.0 veröffentlichen, mit der Nutzer innerhalb weniger Minuten eine animierte Architekturkarte ihres SaaS entwerfen können. Zu den Hauptfunktionen gehören Smart Sections, Smart Edges, Smart Node Deletion, Dark/Light Modes, Embeddable, Drag n Drop images/svgs/gifs, AWS/Windows/Google Icons sowie Markdown-Unterstützung.
• Ein anderer Nutzer argumentiert, dass es schwierig sein kann, „schöne“ Diagramme beizubehalten, sobald sich das System zu verändern beginnt, und schlägt diagrams-as-code als effizientere Alternative vor.
• Ein Nutzer beklagt, dass große Sprachmodelle zwar möglich seien, es aber kein lokales Tool gebe, das Blöcke und Pfeile für ästhetische Schönheit neu anordnet. Er fragt sich, warum es kein Tool gibt, bei dem Nutzer Kästen und Pfeile zeichnen können und das Tool dann alles so ausrichtet, dass es hübsch aussieht.
• Ein Nutzer zieht Parallelen zwischen Softwarearchitekturdiagrammen und elektrischen Schaltplänen, Schaltkreisdiagrammen sowie anderen technischen Zeichnungen. Er argumentiert, dass es keine „richtige Antwort“ gibt und dass die Wahl guter Abstraktionen und Darstellungsweisen verständliche Ideen von bedauerlichem Chaos trennt.
• Ein Nutzer teilt seine Erfahrung mit dem Zeichnen von Diagrammen mit yEd. Mit diesem Tool kann man Kästen und Pfeile völlig durcheinanderbringen, aber mit ein paar Klicks im Menü wird alles automatisch aufgeräumt.
• Ein Nutzer bedankt sich für einen Artikel, der auf praktische Weise erklärt, wie man etwas schöner macht. Er verlässt sich normalerweise auf sein Gefühl.
• Ein Nutzer berichtet von seiner Erfahrung mit D2, mit dem große D2-Diagramme automatisch aus serverless.yml-Dateien erzeugt werden. Das Tool aktualisiert sich automatisch, wenn das System wächst.
• Ein anderer Nutzer ergänzt in seinem Blogbeitrag die D2-Sprache, um das Thema Cybersecurity-Design-Code zu behandeln.
• Ein Nutzer schlägt vor, plantuml-Blöcke hinzuzufügen, um Diagramme in Projekte einzubetten, die als Markdown-Dokumente geschrieben sind. Er weist darauf hin, dass sie in GitLab gut gerendert werden, wenn man .md-Dateien im Webbrowser aufruft, während GitHub diese Funktion noch nicht hat.