Technische Dokumentation

1:1-Anleitung dank Typenschlüssel mit Steuerungsfunktion

Seite: 3/3

Anbieter zum Thema

Zauberwort „Metadaten“

Im Redaktionssystem wurden Metadaten für die Klassifizierung der Module hinterlegt. Metadaten wurden sowohl für die textlichen Informationseinheiten als auch für die Elemente des Typenschlüssels angelegt. Hierarchische Elemente wurden in einem hierarchischen Metadatum abgebildet, für die nicht-hierarchischen Elemente wurden Kategorien gebildet und die Metadaten in Auswahlfeldern bereitgestellt. Jedes Modul wurde daraufhin mit eindeutigen Metadaten sowohl hinsichtlich seiner jeweiligen Informationsart als auch seiner „Zugehörigkeit“ zu einem Produktbestandteil verschlagwortet. Damit waren die Informationen für einen gezielten Zugriff vorbereitet.

Nach der Pflicht die Kür: Regelbasierte Steuerung von Informationen aus dem Typenschlüssel

Zuletzt wurden Regeln erarbeitet, nach denen die Ausgabe einer spezifischen, aus dem Typenschlüssel generierten Installationsanleitung erfolgen sollte. Die Regeln mussten mehrere Aspekte berücksichtigen, z. B.:

  • Die zugrundeliegende Logik für die Publikation der Inhalte: Und, Oder, Und/Oder-Verknüpfung? Filterung oder Aggregation (Zusammenstellung) von Inhalten?
  • Berücksichtigen von Informationen, für die es keine Entsprechung auf der Produktseite gibt (z. B. allgemeines Sicherheitskapitel u. Ä.)
  • Komponenten des Typenschlüssels, die nicht dokumentationsrelevant sind, sollten im Publikationsprozess nicht berücksichtigt werden. Sie haben sich quasi „nicht qualifiziert“, mit Informationen verknüpft zu werden.

Die ersten Testversuche verliefen positiv. Zwar musste an einigen Stellen nachgebessert werden, doch das Gesamtkonzept funktionierte. Das Unternehmen ist derzeit damit beschäftigt, diesen neuen Prozess systemtechnisch zu etablieren. (mz)

* Kirsten Schröder, Technische Redakteurin und Beraterin, tecteam GmbH

(ID:44620958)