Unabhängig vom Architekturstil verwendet jedes IT-System Informationsobjekte. Diese Objekte sind ganz allgemein Daten (“etwas, das existiert”) oder repräsentieren einen Zustand im einem Datenspeicher. Ein Informationsobjekt hat häufig eine Identität. Der Baustein Entity ist ein Artefakt der Systemstruktur, mit dem wir solche Ergebnisse der Software-Entwicklung dokumentieren. Dabei steht der fachliche Nutzen des Dienstes im Vordergrund. Der Titel des Bausteins gibt einem wichtigen Informationsobjekt einen eindeutigen Namen.
Autoren wollen im Baustein Entity nur das dokumentieren, was Entwickler nicht durch lesbare Teile vom Code oder code-nahe Artefakte bereits ausreichend gut dokumentiert haben. Mit einem Avro-Schema oder einem Json-Schema kann beispielsweise ein auf JSON basierendes Informationsobjekt spezifiziert werden. Mit einem XML-Schema spezifizieren Entwickler ein auf XML basierendes Informationsobjekt. Autoren beschreiben im Wiki nur, was sich gar nicht oder sehr schwer aus dem Code herauslesen lässt. Sie erläutern Code ausschließlich dort, wo es notwendig ist.
Projektmanagement
Der Produktverantwortliche hat mit dem Baustein Entity die Möglichkeit, frühzeitig ein wichtiges Informationsobjekt als Entwurf zu erfassen, wenn es für das Verständnis der Anwendungsdomäne hilfreich ist. Er macht das in Abstimmung mit dem Team.
Im Steckbrief des Bausteins befindet sich eine Liste der geplanten Technologien für die Implementierung des Informationsobjektes. Das ist eine sehr wertvolle Information für das Architekturmanagement, um Themen wie Lizenzkosten, technische Unterstützung vom Hersteller oder unternehmensweite Vorgaben rechtzeitig zu behandeln.
Anforderungsanalyse
Der Produktverantwortliche hat mit dem Baustein Entity die Möglichkeit, alle Eigenschaften eines Informationsobjektes zu beschreiben, die wichtig für das Verständnis der Fähigkeiten der Software sind. Er macht das in Abstimmung mit dem Team.
Produktentwicklung
Der Baustein Entity ist für Leser (z.B. Entwickler oder Tester) der zentrale Einstieg, um sich über die Bedeutung eines Informationsobjekt und seiner Eigenschaften zu informieren. Der Überblick im Baustein muss jeden Leser in die Lage versetzen, das Objekt fachlich einzuordnen. Die Festlegung der Identität eines Informationsobjektes ist hilfreich, um eindeutige Schlüssel für Indizierung oder Partitionierung ableiten. In der im Baustein veröffentlichten Spezifikation finden Leser alle Details zur Implementierung des Informationsobjektes.
Gemäß Prinzip COD gilt der Titel des Bausteins und die Namen der beschriebenen Eigenschaften als Vorgabe für den Namen der Implementierungsklasse und die Bezeichner der Attribute eines Informationsobjektes. Mit dieser einfach umzusetzenden Regel muss kein Autor mehr eine spezielle Dokumentation im Wiki schreiben, um ein Informationsobjekt mit der technischen Lösung zu verknüpfen. Der Titel des Bausteins reicht als Einstieg in die Implementierung.
Das Wiki.
Ein Erfolgsfaktor.
-
Schnittstellenbeschreibung für Partnersysteme
Schnittstellenbeschreibungen sind alternativlos in einer komplexen IT-Systemlandschaft mit vielen unabhängigen Partnersystemen aus verschiedenen Organisationen eines Unternehmens. Ein Produktverantwortlicher darf sich trotzdem die Frage stellen, wie umfangreich so ein Dokument sein muss. Mit cards+ kann er das Wiki zu seinem Vorteil nutzen.
Jetzt lesen