Netzwerksolution Documentation Report

Wissensübersicht

Glossarbegriffe erklären Begriffe. Learning Nuggets vermitteln Zusammenhänge. Die Übersicht wird vollständig aus den vorhandenen Wissensartefakten generiert.

Darstellungsnotation

Die Symbole ordnen ein Wissenselement ein. Die englischen Schlüssel bleiben für Verträge und Übersetzungen stabil; die deutsche Bezeichnung ist die primäre Lesesprache.

Bedeutung meaning
Ziel, Regel, Begriff oder Begründung.
Artefakt artifact
Konkretes, referenzierbares oder materialisierbares Element.
Beziehung relationship
Verbindung, Zuordnung oder Abhängigkeit zwischen Elementen.
Kontext und zeitliche Einordnung context-time
Ausführung, Evidence, Feedback oder zeitlicher Kontext.

Glossar · Architecture Knowledge Base

Fachliche Heimat eines Glossarbegriffs

Die fachliche Heimat ist das genau eine primäre Themenfeld, das Verantwortung, Pflege und bevorzugten fachlichen Einstieg eines Glossareintrags bestimmt. Weitere Themenfelder dürfen zusätzliche Verwendungskontexte sichtbar machen, erzeugen aber keine zweite Heimat.

Architecture Knowledge Base · Architekturbegriff · ART-DEF-0024

Glossareintrag

Ein Glossareintrag ist ein eindeutig identifizierbares Architecture Artifact, das die verbindliche Bedeutung eines Begriffs, seine Kurzdefinition, fachliche Heimat, Ownership und optional weitere Erklärungen, Synonyme, Abgrenzungen und Themenfelder beschreibt.

Architecture Knowledge Base · Architekturbegriff · ART-DEF-0023

Semantische Glossarreferenz

Eine semantische Glossarreferenz verweist stabil auf die Identität und Bedeutung eines Glossareintrags. Sie legt nicht fest, ob eine Ausgabe daraus einen Link, eine Kurzdefinition, eine Fußnote, ein Popover oder eine andere Darstellung erzeugt.

Architecture Knowledge Base · Architekturbegriff · ART-DEF-0025

Glossar · Documentation Architecture

Documentation Publisher

Der Documentation Publisher ist die Komponente, die Documentation Sources, Artefaktreferenzen, Navigation und Assets in menschenlesbare Reports materialisiert.

Documentation Architecture · Architekturbegriff · ART-DEF-0015

Documentation Source

Eine Documentation Source ist die führende, manuell gepflegte Quelle einer Dokumentationsaussage oder Definition. Sie darf wiederverwendbare Definitionen referenzieren, soll sie aber nicht duplizieren.

Documentation Architecture · Architekturbegriff · ART-DEF-0012

Human Readable Report

Ein Human Readable Report ist eine generierte, lesbare Ausgabe aus Documentation Sources und Artefaktreferenzen. Er kann für Menschen Definitionen auflösen, Links erzeugen und Kontextinformationen einbetten.

Documentation Architecture · Architekturbegriff · ART-DEF-0013

Markdown Exchange Format

Markdown ist in der Engineering-Landschaft ein Austausch-, Arbeits- und Reportformat. Es ist nicht die endgültige fachliche Quelle, sobald das Artefaktmodell als führende Modellierungsquelle verfügbar ist.

Documentation Architecture · Architekturbegriff · ART-DEF-0014

ProcessedDocument

Medienneutrale, validierte und bereits aufgelöste Dokumentprojektion, die einem Renderer zur Darstellung übergeben wird.

Documentation Architecture · Architekturbegriff · ART-DEF-0034

Reference Resolver

Der Reference Resolver löst stabile Artefaktreferenzen wie ART-DEF-0001, konkrete ADR-IDs oder spätere GUID-basierte Referenzen gegen das Artefaktmodell beziehungsweise den aktuellen Markdown-Arbeitsbestand auf.

Documentation Architecture · Architekturbegriff · ART-DEF-0016

Renderer

Ein Renderer erzeugt eine konkrete technische Ausgabeform aus einer vorbereiteten Dokumentationsprojektion. Beispiele sind HTML, PDF, Markdown, JSON oder ein Suchindex.

Documentation Architecture · Architekturbegriff · ART-DEF-0017

Theme

Ein Theme beschreibt die visuelle und strukturelle Gestaltung eines Reports, beispielsweise CSS, einfache JavaScript-Erweiterungen, Navigation, Logo, Schriftgrößen oder Farbdefinitionen.

Documentation Architecture · Architekturbegriff · ART-DEF-0018

Glossar · Knowledge Layer

Learning Nugget

Didaktisches Wissensartefakt, das ein Architektur- oder Technikthema verständlich erklärt, ohne normative Architekturregeln zu ersetzen.

Knowledge Layer · Wissensartefakttyp · ART-DEF-0035

Glossar · Ohne Thema

ADR

Ein ADR (Architecture Decision Record) dokumentiert eine Architekturentscheidung mit ihrem Kontext, ihrer Begründung und ihren Folgen.

Ohne Thema · EA-GLOSS-ADR-001

Architecture Compliance Contract

Ein Architecture Compliance Contract verbindet eine Architekturregel mit konkreten Implementierungs- und Testnachweisen.

Ohne Thema · ART-DEF-0042

Bedeutung

Bedeutung beschreibt den fachlichen Sinn eines Elements und seine Relevanz für Menschen und Organisationen.

Ohne Thema · EA-GLOSS-BEDEUTUNG-001

Beziehung

Eine Beziehung beschreibt eine nachvollziehbare Verbindung zwischen Bedeutungen, Artefakten und ihrem Kontext.

Ohne Thema · EA-GLOSS-BEZIEHUNG-001

Building Block

Ein Building Block ist ein abgegrenzter Baustein mit stabiler Verantwortung zur Realisierung von Capabilities.

Ohne Thema · EA-GLOSS-BUILDING-BLOCK-001

Capability

Eine Capability beschreibt ein dauerhaft benötigtes fachliches Leistungsvermögen, nicht dessen technische Umsetzung.

Ohne Thema · EA-GLOSS-CAPABILITY-001

Code

Code ist eine ausführbare oder interpretierbare technische Realisierung, die durch Tests und Runtime-Evidence überprüfbar bleibt.

Ohne Thema · EA-GLOSS-CODE-001

Discovery

Technical documentation artifact.

Ohne Thema · ART-DEF-0053

Evidence

Technical documentation artifact.

Ohne Thema · ART-DEF-0043

Execution Capability

Bezeichnet die Capability zur kontrollierten technischen Ausführung und Nachweisführung, ohne die universelle Execution-Semantik zu ersetzen.

Ohne Thema · GLOSSARY-EXECUTION-CAPABILITY

Feature

Ein Feature ist eine abgegrenzte, nutzbare und lieferbare Ausprägung einer Lösung.

Ohne Thema · EA-GLOSS-FEATURE-001

Finding

Technical documentation artifact.

Ohne Thema · ART-DEF-0050

Freshness Gate

Technical documentation artifact.

Ohne Thema · ART-DEF-0047

Git

Git ist das verwendete Versionsverwaltungssystem für nachvollziehbare Änderungsgeschichte.

Ohne Thema · EA-GLOSS-GIT-001

Intake

Technical documentation artifact.

Ohne Thema · ART-DEF-0054

Kontext und Zeitbezug

Kontext und Zeitbezug beschreiben, unter welchen Bedingungen und zu welchem Zeitpunkt eine Aussage oder Evidence gilt.

Ohne Thema · EA-GLOSS-KONTEXT-ZEITBEZUG-001

Ledger

Ein Ledger ist eine versionierte, menschenlesbare Ergänzung für ausgewählte Beziehungen.

Ohne Thema · EA-GLOSS-LEDGER-001

Metamodell

Ein Metamodell beschreibt die zulässigen Kategorien, Eigenschaften und Beziehungen, mit denen Wissen modelliert wird.

Ohne Thema · EA-GLOSS-METAMODELL-001

MVP

Ein MVP ist eine kleinste überprüfbare Materialisierung mit bewusst begrenztem Umfang.

Ohne Thema · EA-GLOSS-MVP-001

Plateau

Ein Plateau ist ein zeitlich eingeordneter, freigegebener Reife- oder Materialisierungsstand.

Ohne Thema · EA-GLOSS-PLATEAU-001

Promotion

Technical documentation artifact.

Ohne Thema · ART-DEF-0049

Provenienz

Technical documentation artifact.

Ohne Thema · ART-DEF-0044

Provenienz

Provenienz beschreibt die nachvollziehbare Herkunft eines Wissenselements, einer Aussage oder einer abgeleiteten Darstellung.

Ohne Thema · EA-GLOSS-PROVENIENZ-001

Release

Ein Release ist ein bewusst freigegebener und nachvollziehbarer Stand von Artefakten und ihrer Realisierung.

Ohne Thema · EA-GLOSS-RELEASE-001

Retention

Technical documentation artifact.

Ohne Thema · ART-DEF-0048

Service

Ein Service ist eine abgegrenzte bereitgestellte technische oder fachliche Leistung mit klarer Verantwortung.

Ohne Thema · EA-GLOSS-SERVICE-001

SHA-256

Technical documentation artifact.

Ohne Thema · ART-DEF-0055

supersedes

supersedes bedeutet: Ein neuer Stand löst einen früheren Stand explizit ab.

Ohne Thema · EA-GLOSS-SUPERSEDES-001

UTF-8 Markdown

Technical documentation artifact.

Ohne Thema · ART-DEF-0051

Vision

Eine Vision beschreibt eine langfristig gewünschte Wirkung und gibt der Weiterentwicklung eine gemeinsame Richtung.

Ohne Thema · EA-GLOSS-VISION-001

Glossar · Persistence and Runtime

Cache

Ein Cache ist ein technischer Beschleunigungsmechanismus für Inhalte aus einer bestehenden Zustandsklasse. Er ist keine eigenständige fachliche Zustandsklasse und darf keine konkurrierende fachliche Wahrheit erzeugen.

Persistence and Runtime · Architekturbegriff · ART-DEF-0022

Ephemerer Runtime State

Ephemerer Runtime State unterstützt eine laufende Interaktion oder Sitzung und darf ohne Verlust bestätigter fachlicher Wahrheit ablaufen oder verloren gehen. Presence, Cursor und kurzfristige Sitzungszustände sind typische Beispiele.

Persistence and Runtime · Architekturbegriff · ART-DEF-0021

Operativ persistierter Zustand

Operativ persistierter Zustand wird für Betrieb, Synchronisation, Verarbeitung, Nachvollziehbarkeit oder Wiederaufnahme dauerhaft geführt, ist aber keine fachliche Wahrheit des Write Models. Er kann eine eigene operative Identität und einen eigenen Lebenszyklus besitzen.

Persistence and Runtime · Architekturbegriff · ART-DEF-0020

Runtime Resource

Eine Runtime Resource ist eine materialisierte Laufzeitdarstellung freigegebener Artefakte oder Projektionen. Sie kann technisch als JSON, YAML, Resource-Bundle oder vergleichbare Datei vorliegen.

Persistence and Runtime · Architekturbegriff · ART-DEF-0011

Write Model

Das Write Model ist die fachlich führende Quelle veränderbarer Informationen. Hier entsteht und ändert sich fachliche Wahrheit über die dokumentierten Schreibpfade des jeweiligen Owners. Das Write Model ist ein fachlicher Architekturbegriff und kein konkretes Datenbankprodukt.

Persistence and Runtime · Architekturbegriff · ART-DEF-0019

Glossar · Unified Artifact Model

Artefakt

Ein Artefakt ist jede eindeutig identifizierbare fachliche, technische, organisatorische oder reale Einheit, die in der Engineering-Landschaft modelliert wird.

Unified Artifact Model · Architekturbegriff · ART-DEF-0001

Artifact GUID

Die artifactguid ist die stabile, globale und technische Identität eines Artefakts. Sie identifiziert das Artefakt dauerhaft und eindeutig, unabhängig von Dateiname, Ordner, Alias, Titel, Projektion oder Materialisierung.

Unified Artifact Model · Architekturbegriff · ART-DEF-0002

Artifact ID

Die Artifact ID ist die sprechende, menschenlesbare Identität eines Artefakts. In Markdown-Headern wird sie im Feld id geführt.

Unified Artifact Model · Architekturbegriff · ART-DEF-0003

Attribute

Attribute sind Eigenschaften eines Artefakts. Sie werden nicht automatisch als eigene Artefakte modelliert.

Unified Artifact Model · Architekturbegriff · ART-DEF-0005

Dimension

Eine Dimension beschreibt eine Ausprägung eines Artefakts oder eines Attributwerts. Sprache ist keine Sonderbehandlung, sondern eine mögliche Dimension.

Unified Artifact Model · Architekturbegriff · ART-DEF-0006

Materialization

Eine Materialisierung ist die technisch erzeugte und persistierte Darstellung einer Projektion.

Unified Artifact Model · Architekturbegriff · ART-DEF-0009

Projection

Eine Projektion ist eine fachliche Sicht auf ein Artefakt oder eine Artefaktmenge in einem bestimmten Kontext.

Unified Artifact Model · Architekturbegriff · ART-DEF-0008

Relation

Eine Relationship beschreibt eine fachliche oder technische Beziehung zwischen Artefakten. Sie erhält eine stabile eigene Relationship-Identität, wenn sie eigene Attribute, Status, Historie oder Governance trägt. Sie bleibt dabei ein eigenständiges UAM-Grundelement und wird nicht zu einem Artifact.

Unified Artifact Model · Architekturbegriff · ART-DEF-0007

Single Artifact Instance

Ein Artefakt existiert fachlich genau einmal im Universum der Engineering-Landschaft. Mehrfache Darstellungen, Verwendungen, Diagrammknoten, Runtime-Dateien, Reports oder Exportformate erzeugen keine weiteren Artefakte.

Unified Artifact Model · Architekturbegriff · ART-DEF-0004

Single Point of Truth

Die führende Quelle für fachliche Artefakte ist das Artefaktmodell beziehungsweise die Modellierungsdatenbank. Dateien, Reports, Runtime-Ressourcen und Exporte sind nur dann führend, wenn sie ausdrücklich als Quellartefakte des jeweiligen Arbeitsmodus definiert sind.

Unified Artifact Model · Architekturbegriff · ART-DEF-0010

Universe Artifact Identity Registry

Zentrale Autorität für universumsweit eindeutige Artefaktidentitäten, GUIDs, referenzierbare Aliase und führende Quellen.

Unified Artifact Model · Architekturbegriff · ART-DEF-0029

Glossar · Universe Management

Dependency Closure

Abgeschlossene Menge aller Artefakte und Repositorys, die für eine konkrete Prüfung oder Bearbeitung aufgrund ihrer Abhängigkeiten benötigt werden.

Universe Management · Architekturbegriff · ART-DEF-0031

Task Context Snapshot

Minimierter, versionierter Arbeitskontext aus betroffenen Artefakten, Repository-Katalogen und der erforderlichen Dependency Closure.

Universe Management · Architekturbegriff · ART-DEF-0030

Universe Snapshot

Versionierte Zusammenstellung eines bekannten Universe-Zustands mit Artefaktidentitäten, Beziehungen, Issues, Eingangsständen und Validierungsergebnis.

Universe Management · Architekturbegriff · ART-DEF-0028

Glossar · Validation

Pending Input

Issue-Zustand für ein derzeit nicht auflösbares Ziel, das durch ein noch nicht bereitgestelltes Repository oder Artefakt nachgeliefert werden kann.

Validation · Statusbegriff · ART-DEF-0032

Reconciliation

Erneute, zustandsbasierte Bewertung des Universe Catalogs und seiner Issues nach geänderten oder nachgelieferten Eingängen.

Validation · Prozessbegriff · ART-DEF-0033

Learning Nuggets · Documentation Architecture

Warum ein ProcessedDocument benötigt wird

Ein SourceDocument enthält noch nicht alle für eine Ausgabe benötigten, medienneutralen Auflösungen. Das ProcessedDocument bündelt aufgelöste Referenzen, semantische Annotationen und Validierungsergebnisse vor dem Rendering.

Documentation Architecture · NUG-0005-WARUM-EIN-PROCESSED-DOCUMENT-BENOETIGT-WIRD

Warum Renderer keine Semantik auflösen

Renderer entscheiden über die technische Ausgabeform. Würden sie zusätzlich Begriffe, Identitäten und Beziehungen auflösen, entstünden für HTML, PDF und andere Medien konkurrierende Wahrheiten.

Documentation Architecture · NUG-0006-WARUM-RENDERER-KEINE-SEMANTIK-AUFLOESEN

Learning Nuggets · Ohne Thema

Warum Architektur-Compliance explizite Verträge braucht

Ein Architekturtext ist wie eine Bauordnung: Er beschreibt, was gelten soll. Ein Test ist wie eine konkrete Abnahme am Gebäude. Dazwischen braucht es eine Prüfliste, die sagt, welche Regel an welcher Stelle und mit welchem Nachweis kontrolliert wird.

Ohne Thema · NUG-0010-WARUM-ARCHITEKTUR-COMPLIANCE-EXPLIZITE-VERTRAEGE-BRAUCHT

Warum Berichte keine Installationspakete sind

Ein Paket kann wie ein Paket aussehen und trotzdem etwas völlig anderes wollen. Ein Möbelkarton enthält Teile, die eingebaut werden sollen. Ein Prüfbericht im Umschlag enthält dagegen Informationen über das Möbelstück. Niemand würde den Prüfbericht in den Schrank einbauen. Genauso verändern SolutionArchitecture-, Workspace- und Patch-Pakete einen Zielzustand. Cleanup- und Verifikationsberichte erklären nur, was geprüft wurde oder noch zu tun ist.

Ohne Thema · NUG-0009-WARUM-BERICHTE-KEINE-INSTALLATIONSPAKETE-SIND

Warum mehrere Materialisierungen nur ein Referenzziel haben

Ein Buch bleibt dasselbe Buch, auch wenn es als Hardcover, E-Book und PDF vorliegt. Die Ausgaben sind unterschiedliche Materialisierungen, aber sie beschreiben nicht drei verschiedene Werke. Genauso kann ein Artefakt in der Engineering-Landschaft als Markdown-Quelle, HTML-Seite, PDF oder historische Kopie erscheinen. Die Referenz zeigt fachlich auf die eine Artefaktidentität. Erst danach wird entschieden, welche Darstellung für den aktuellen Zweck verwendet wird.

Ohne Thema · NUG-0008-WARUM-MEHRERE-MATERIALISIERUNGEN-NUR-EIN-REFERENZZIEL-HABEN

Warum Todo und Review keine Links sind

Eine Artefaktreferenz sagt: „Dieses andere Artefakt ist gemeint.“ Eine Todo- oder Review-Annotation sagt: „An dieser Stelle ist Arbeit nötig.“ Beide verwenden sichtbare Marker, erfüllen aber völlig unterschiedliche Aufgaben.

Ohne Thema · NUG-0007-WARUM-TODO-UND-REVIEW-KEINE-LINKS-SIND

Learning Nuggets · Persistenz und Betrieb

Warum Git nur für validierte Snapshots?

Git ist sehr gut darin, bestätigte textbasierte Zustände nachvollziehbar zu versionieren. Es ist jedoch kein Transaktionssystem für jeden einzelnen Laufzeitschritt einer Registry.

Persistenz und Betrieb · NUG-0002-WARUM-GIT-NUR-FUER-VALIDIERTE-SNAPSHOTS

Learning Nuggets · Persistenz und Runtime

Warum SQLite mit WAL?

SQLite speichert eine relationale Datenbank in einer Datei. Im WAL-Modus werden Änderungen zunächst in ein separates Write-Ahead Log geschrieben. Dadurch bleibt ein abgeschlossener Zustand auch bei einem Prozess- oder Rechnerabbruch rekonstruierbar.

Persistenz und Runtime · NUG-0001-WARUM-SQLITE-MIT-WAL

Learning Nuggets · Praxiserfahrung

Learning Nuggets · Unified Artifact Model

Warum Artefakt-IDs universumsweit eindeutig sind

Repositorys sind Ablage- und Ownership-Kontexte, aber keine getrennten Identitätsräume. Ein Artefakt bleibt dasselbe Artefakt, auch wenn es in mehreren Projektionen oder Materialisierungen erscheint.

Unified Artifact Model · NUG-0003-WARUM-ARTEFAKT-IDS-UNIVERSUMSWEIT-EINDEUTIG-SIND

Learning Nuggets · Validation

Warum Pending Input noch kein kaputter Link ist

Eine Referenz kann vorübergehend nicht auflösbar sein, weil das zuständige Repository noch nicht eingespielt wurde. Das ist ein unvollständiger Universe-Zustand, nicht automatisch ein fachlicher Fehler.

Validation · NUG-0004-WARUM-PENDING-INPUT-KEIN-KAPUTTER-LINK-IST

Learning Nuggets · Warum sollte eine wachsende Architektur nicht bei jeder Erkenntnis sofort neue Grundelemente einführen?

Architektur wächst durch Konsolidierung

Erklärt, warum Architektur durch semantische Konsolidierung stabil wächst.

Warum sollte eine wachsende Architektur nicht bei jeder Erkenntnis sofort neue Grundelemente einführen? · LN-ARCH-001

Learning Nuggets · Wissensmuster