5 Beispiele für automatisierte Technische Dokumentation

Technische Dokumentation bei WAGO

Die WAGO Gruppe gehört zu den großen Playern in der Branche der Verbindungs- und Automatisierungstechnik. Mit 9.000 Mitarbeitern erwirtschaftete sie 2022 weltweit 1,34 Mrd. €. Dass die Technische Dokumentation für ein solches Unternehmen eine wichtige Rolle spielt, versteht sich von selbst. Deshalb entschied sich WAGO schon 2009 für ein CCMS, seit 2019 verwendet das Unternehmen auch ST4.

Doch obwohl das Arbeiten mit einem CCMS eine deutlichen Produktivitätsvorsprung mit sich bringt, war da das Gefühl, dass noch mehr geht: Mehr Informationsprodukte, mehr Sprachen und mehr Inhalte. Dabei sollte die Content-Qualität steigen und die verschiedenen Systeme sollten besser integriert werden. Diese Ziele sollten natürlich am besten so erreicht werden, dass die Arbeit sowohl für die Fachexperten als auch die Redaktion leichter wird. Keine einfache Aufgabe!

Die Lösung fand die Redaktion von WAGO in den Automatisierungsmechanismen von SCHEMA ST4. Anhand von fünf Beispielen haben sie uns gezeigt, wie sie mit Workflows mehr aus ihrem CCMS herausholen.

Beispiel 1: Document Health Check

Nicht jedes Dokument, das in einem CCMS erzeugt wird, folgt automatisch allen Redaktionsregeln. Unterschiedliche Gewohnheiten bei der Gestaltung der Dokumentarchitektur können zu einem uneinheitlichen Output führen. Im schlimmsten Fall fehlen Inhalte oder sie verweisen auf veraltete Stände.

Mit einem automatisierten Workflow lässt sich bei WAGO in jedem blauen Buch in SCHEMA ST4 prüfen, wie es um die Qualität der Output-Dokumente steht. Wie sieht die Verschachtelung der unterschiedlichen Knotentypen aus? Stimmt die Topic-Klassifizierung? Gibt es unbearbeitete Kommentare oder statische Querverweise. Solche und andere Probleme identifiziert der Workflow „Document Health Check“ und macht dadurch die Qualität der Dokumentation mit einfachen Mitteln ein gutes Stück besser.

Beispiel 2: Übersetzungsstatus

Die Übersetzungsfunktionalitäten in SCHEMA ST4 sind ausgereift und hocheffizient. Gelegentlich sind sie aber zu mächtig, zum Beispiel dann, wenn in einem Dokument nur kleine terminologische Anpassungen vorgenommen oder nur einige wenige Zahlenwerte geändert wurden. In diesen Fällen lohnt es sich nicht, einen kompletten TMS-Export anzustoßen. Dann nutzen Redakteure gern die Möglichkeit, direkt in Zielsprache zu editieren. Beim nachfolgenden „Korrigieren“ vom Übersetzungsstatus passieren aber leicht Fehler.  Daher hilft beim Setzen des Übersetzungsstatus nun ein Workflow. So wird die „Korrektur“ des Status auch wirklich nur noch auf frisch veränderte Objekte angewandt.

Beispiel 3: Variantenabdeckung

Die Arbeit mit Varianten kann in komplexen Content-Beständen gelegentlich recht unübersichtlich werden. Dann ist es nur schwer zu entscheiden, ob eine Variante vielleicht ins Leere läuft oder nicht präzise abgedeckt wird.

Die Technische Redaktion der WAGO Gruppe hat sich deshalb einen Workflow erstellt, der die Variantenabdeckung prüft. Er simuliert, was ein Variantenfilter ausgeben würde. Dabei erzeugt er in Sekunden auf Topic-Ebene eine sehr kompakte Liste, wo es gegenüber der Vorlage Lücken oder Mehrdeutigkeiten gibt. Die Kontrolle auf falsch klassifizierte oder fehlende Inhalte („sehen was man nicht sieht“) verlangt nun keine Detektivarbeit mehr.

Beispiel 4: Verlaufskommentare

SCHEMA ST4 bietet zwar vielfältige Möglichkeiten, Arbeitsabläufe mit Kommentaren zu begleiten. Diese funktionieren aber meist dadurch, dass man Objekte freigibt und versioniert. Manchmal wäre aber eine Art Logbuch hilfreich, das ohne Versionierung funktioniert. In nur drei Stunden Entwicklungszeit realisierte sich WAGO einen Workflow, mit dem sich Kommentare zu einem Arbeitsprozess an beliebigen Objekten in eine Kommentarsammlung posten und wieder geordnet aufrufen lassen.

Beispiel 5: Topic-Wizard

Wenn neue Topics in den Content-Bestand eingeführt werden, dann ist die Umstellung nicht immer ganz leicht. Schnell vergisst man ein Metadatum oder eine falsche Inhaltsvorlage wird kopiert. Für solche Fälle hat sich die Technische Redaktion von WAGO einen Workflow-Wizard programmiert, der den Redakteuren und Redakteurinnen zur Hand geht. Er legt die neuen Knoten an, befüllt diese automatisch vorab mit Standard-Metadaten und schlägt freigegebene Inhalte für das Template vor. Die Content-Erstellung wird dadurch bequemer und sicherer, lästige Arbeitsschritte entfallen.

Die WAGO Gruppe hat die Automatisierungsmöglichkeiten von SCHEMA ST4 lieben gelernt und die Technische Redaktion ist sich sicher, dass auch in Zukunft noch viele fleißige Automatisierungs-Helferlein die Arbeit bereichern werden. Wenn Sie gerne weitere Ideen zur Automatisierung Ihrer Technischen Dokumentation kennen lernen möchten, dann klicken Sie hier.