Um eine Dokumentation zu erstellen oder anzupassen, ist es hilfreich, den Zusammenhang von Modelldatenstruktur und Dokumentationsstruktur zu verstehen.
Die Kernaufgabe eines Konfigurators bei der Vorbereitung einer Dokumentationsgenerierung besteht darin, geeignete Dokumentationsstrukturen aufzubauen, mit denen sich die im Datenmodell verteilten Einzelinformationen in eine dokumentierbare, d. h. lineare Form überführen lassen. Eine solche Struktur kann man sich als einen (baumförmigen) Pfad durch das Netz der Informationsstruktur vorstellen, nach Möglichkeit redundanzfrei aufgebaut, also so, dass relevante Informationen genau einmal in der Dokumentation auftauchen.
Um diese Aufgabe erfüllen zu können, muss ein Konfigurator wissen, wie diese Doku-Strukturen mit den anderen Teilen einer Konfiguration zusammenhängen, genauer gesagt mit den Vorgaben des Innovator-Datenmodells.
Vom Grad der Abstraktion her muss man eine Doku-Struktur in der Mitte einordnen zwischen den konkreten Modellelementen und dem (abstrakten) Datenmodell von Innovator, in dem die Modellelemente und Diagramme gespeichert und verwaltet werden.
-
Die Doku-Struktur beschreibt, welche Informationen in welcher Reihenfolge zu einem Modellelement ausgegeben werden sollen. Dies wird nicht für jedes Modellelement einzeln festgelegt, sondern unabhängig von einem Innovator-Modell und seinen konkreten Modellinhalten für den jeweiligen Typ eines Modellelements (z. B. Klassendiagramm oder Anwendungsfall).
So gesehen ist eine Doku-Struktur abstrakter als das Modell, das sie dokumentieren soll.
-
Das Innovator-Datenmodell ist ein relationales Datenmodell und beschreibt, welche Zusammenhänge sich in einem Modell überhaupt konstruieren lassen (zu einer Klasse kann man z. B. kein Anwendungsfalldiagramm erstellen, weil es methodisch keinen Sinn hat). Diese Zusammenhänge werden durch Verknüpfungen zwischen den jeweiligen Tabellen des Innovator-Datenmodells realisiert. Eine Doku-Struktur kann deshalb nur solche Zusammenhänge finden, zu denen es auch eine entsprechende Verknüpfung im Datenmodell gibt.
So gesehen ist die Doku-Struktur weniger abstrakt als das zugrundeliegende Datenmodell.
-
Bei der Konfiguration eines Profils können Einschränkungen nur für solche Beziehungen formuliert werden, zu denen es auch eine entsprechende Verknüpfung im Datenmodell gibt.
So gesehen ist eine Doku-Struktur auf dem gleichen Abstraktionsgrad wie ein Profil. Doku-Strukturen lassen sich daher gut im Rahmen von Profilen verwalten.
Ein beim Aufbau einer Doku-Struktur verfügbares Standardkapitel ist deshalb nichts anderes als entweder
-
ein sprechender Name für eine häufig benötigte "Operation", die vom aktuellen Elementtyp ausgehend andere Elementtypen liefert, zu denen eine entsprechende Relation im Datenmodell besteht (Modellelementaufzählungskapitel), oder aber -
ein sprechender Name für ein "Attribut" des aktuellen Elementtyps, dessen Wert in lesbarer Form ausgegeben werden soll (Informationskapitel).
Im ersten Fall liefert ein Kapitel i. d. R. eine Liste von Modellelementen, die mit Hilfe der entsprechenden Abfrageoperation gefunden werden können, im letzten Fall einen einzelnen Wert eines entsprechenden Attributs.
Verwandte Themen
