Motivation
Qualitätssicherung in der Technischen Dokumentation umfasst unterschiedliche Aufgaben. Inhalte müssen fachlich korrekt, vollständig und verständlich sein. Gleichzeitig sollen Rechtschreibung, Grammatik, Terminologie und Stil stimmen. Hinzu kommen strukturelle Vorgaben, die beispielsweise im Redaktionsleitfaden definiert sind.
Im Reviewprozess treffen viele dieser Aufgaben zusammen. Die fachliche und inhaltliche Prüfung erfordert Wissen über Produkt, Zielgruppe und Anwendungskontext. Andere Aspekte lassen sich dagegen anhand definierter Regeln prüfen.
Spezifisch das inhaltliche Lektorat leidet manchmal unter der Qualität der eingehenden Texte. Das bestätigen Gespräche mit Kunden und Interessenten. Statt des inhaltlichen Reviews fallen Aufwände für Korrekturen wie Rechtschreibung, Grammatik, Terminologie und Stil an. Dieser Aufwand geht von der Zeit für die inhaltliche Prüfung ab. Die sprachlichen Probleme stehen zu lassen, ist jedoch ebenfalls keine Option, weil sie die Verständlichkeit der Texte beeinträchtigen.
Ein Teil dieses Nachputzens lässt sich durch automatisierte Prüfungen bereits vor dem inhaltlichen Lektorat abfangen.
Maschinell prüfbare Vorgaben automatisiert anwenden
Nicht jede Qualitätsanforderung lässt sich automatisiert prüfen.
Ob eine Beschreibung fachlich vollständig ist, ob ein wichtiger Arbeitsschritt fehlt oder ob eine Erklärung für die konkrete Zielgruppe verständlich ist, erfordert häufig Erfahrung, Kontext und menschliche Beurteilung.
Andere Anforderungen lassen sich anhand klarer Regeln prüfen:
- Besitzt eine Grafik die vorgeschriebene Beschriftung?
- Wird eine unerwünschte Benennung verwendet?
- Enthält ein Satz einen Rechtschreib- oder Grammatikfehler?
- Verstößt eine Formulierung gegen eine definierte Stilregel?
- Entspricht die Dokumentstruktur den festgelegten Regeln?
Für solche Aufgaben können automatisierte Prüfungen einen Teil der manuellen Arbeit übernehmen.
Für XML-basierte Strukturregeln steht in SCHEMA ST4 beispielsweise Schematron zur Verfügung. Schematron validiert XML-Content anhand definierter Regeln. Schematron-Regeln prüfen insbesondere, ob die XML-Dokumentstruktur den definierten Vorgaben entspricht. Darüber hinaus können Schematron-Regeln in SCHEMA ST4 auch Zusammenhänge zwischen Content und Metadaten prüfen.
Congree setzt auf der sprachlichen Ebene an. Die linguistische Analyse prüft Texte unter anderem auf Rechtschreibung, Grammatik, Terminologie und Stil. Terminologie und sprachliche Regeln lassen sich an die Vorgaben des jeweiligen Unternehmens anpassen.
Schematron und Congree prüfen damit unterschiedliche Qualitätsdimensionen. Schematron betrachtet strukturelle Anforderungen an die XML-Inhalte. Congree analysiert die darin enthaltenen Texte. Beide Prüfungen lassen sich im Redaktionsprozess miteinander kombinieren.
Ein Redaktionsleitfaden wirkt erst durch seine Anwendung
Unternehmen definieren Terminologie, Schreibregeln und strukturelle Vorgaben nicht als Selbstzweck.
Mit diesen Festlegungen sollen konkrete Effekte erzielt werden. Texte sollen beispielsweise verständlicher und konsistenter werden. Bestimmte Formulierungen sollen vermieden werden. Informationen sollen nach einheitlichen Mustern aufgebaut sein. Terminologische Varianten sollen reduziert werden. Die Rechtssicherheit soll erhöht werden, indem unsichere Formulierungen oder die falsche Verwendung von Marken verhindert wird.
Diese Wirkung entsteht allerdings nicht dadurch, dass eine Regel im Redaktionsleitfaden steht.
Sie entsteht erst dann, wenn die Regel beim Erstellen von Inhalten tatsächlich angewendet wird.
Autoren und Lektoren müssen die relevanten Vorgaben kennen und im richtigen Moment anwenden. Je umfangreicher Regelwerk und Terminologie werden, desto schwieriger ist es, dies allein durch Wissen, Schulung und manuelle Kontrolle sicherzustellen.
Automatisierte Prüfungen setzen hier an. Maschinell prüfbare Vorgaben können in Prüfregeln überführt werden, deren Einhaltung das System kontrolliert.
Der Redaktionsleitfaden beschreibt dann nicht nur, wie Inhalte aussehen sollen. Seine maschinell prüfbaren Vorgaben werden im Arbeitsprozess tatsächlich angewendet.
Ohne diesen Schritt besteht die Gefahr, dass ein gut ausgearbeiteter Redaktionsleitfaden in Teilen ein Papiertiger bleibt.
Früher prüfen statt später nacharbeiten
Aus der Softwareentwicklung ist für einen vergleichbaren Ansatz der Begriff Shift Left bekannt. Automatisierte Tests werden möglichst früh in den Entwicklungsprozess eingebunden. Fehler können dadurch bereits früher im Entwicklungsprozess erkannt werden.
Der Grundgedanke lässt sich auf die Technische Dokumentation übertragen.
Wenn eine falsche Benennung bereits beim Erstellen eines Textes erkannt wird, muss sie nicht erst im Lektorat gesucht werden. Wenn eine strukturelle Vorgabe automatisiert geprüft werden kann, muss ihr Verstoß nicht erst bei der Freigabe oder nach der Publikation auffallen.
Dabei geht es nicht darum, jede denkbare Prüfung an den Anfang des Prozesses zu verschieben. Entscheidend ist, maschinell prüfbare Anforderungen an einer sinnvollen Stelle _automatisch_ zu prüfen.
Das kann direkt beim Schreiben geschehen. Es kann aber auch ein definierter Workflow-Schritt vor Review, Freigabe oder Publikation sein.
Qualitätsprüfung automatisch im ST4-Workflow ausführen
Schematron und Congree lassen sich in ST4-Automation-Workflows einbinden. Dabei übernimmt Schematron die strukturelle Prüfung des XML-Contents. Congree ergänzt die sprachliche Prüfung, beispielsweise auf Rechtschreibung, Grammatik, Terminologie und Stil.
Die Prüfungen können an definierten Stellen im Redaktionsprozess automatisch ausgeführt werden. Dadurch müssen Anwender sie nicht jeweils manuell starten.
Wie das geht, wurde im Webinar "Qualität frühzeitig sichern: Schematron und Congree in SCHEMA ST4 konfigurieren und automatisieren" vorgestellt.
Link zur Aufzeichnung: vimeo.com/congree/schematronundcongree
Die workflowgestützte Congree-Prüfung kann außerdem mehrere ST4-Knoten in einem Lauf verarbeiten. Für jeden geprüften Knoten gibt Congree das Prüfergebnis an SCHEMA ST4 zurück. In den Knoteneigenschaften können beispielsweise der ermittelte Congree-Release-Level und Informationen zum Prüfbericht hinterlegt werden.
Der Workflow kann diese Informationen anschließend weiterverwenden. Abhängig vom konkreten Prozess können auf Basis der Prüfergebnisse Folgeaktionen ausgeführt werden, beispielsweise das Erstellen einer Aufgabe zur Korrektur. Die gespeicherten Metadaten können über die Suchfunktion in SCHEMA ST4 ausgewertet werden, um verbesserungsbedürftige Knoten schnell zu identifizieren.
Die automatische Prüfung wird damit selbst zu einem Bestandteil des Redaktionsprozesses.
Mehr Zeit für die Aufgaben, für die Menschen gebraucht werden
Automatisierte Prüfungen ersetzen das fachliche Review oder das juristische Lektorat nicht.
Sie können aber dafür sorgen, dass qualifizierte Mitarbeiter einen größeren Teil ihrer Zeit für genau diese Aufgaben einsetzen können.
Ein technischer Redakteur oder Lektor muss beispielsweise beurteilen:
- Ist die Information fachlich korrekt?
- Fehlt eine wichtige Information?
- Ist die Beschreibung für die Zielgruppe nachvollziehbar?
- Ist die Reihenfolge der Informationen sinnvoll?
- Kann eine Formulierung missverstanden werden?
Bei solchen Fragen sind Fachwissen, Erfahrung und Kontext entscheidend.
Wenn dieselbe Person einen Teil ihrer Zeit für das sprachliche Review benötigt, um Rechtschreibung, Terminologievorgaben oder formale Regeln zu kontrollieren, dann steht diese Zeit für die inhaltliche Arbeit nicht mehr zur Verfügung.
Die sinnvolle Arbeitsteilung lautet deshalb:
Automatisieren Sie, was sich zuverlässig maschinell prüfen lässt. Nutzen Sie menschliche Review-Kapazität dort, wo menschliche Beurteilung erforderlich ist.
Was kostet späte Fehlerkorrektur im eigenen Prozess?
Redaktionsprozesse unterscheiden sich. Ebenso unterschiedlich sind Fehlerhäufigkeit, Zahl der beteiligten Prozessschritte, Korrekturaufwand und Personalkosten.
Wie groß der wirtschaftliche Effekt einer Automatisierung ist, lässt sich deshalb am besten anhand eigener Messwerte bestimmen.
Erfassen Sie vier Wochen lang Fehler, die erst im Review, bei der Freigabe oder in einem späteren Prozessschritt gefunden werden.
Für jeden Fehler werden Angaben benötigt:
- Welche Art von Fehler wurde gefunden?
- In welchem Prozessschritt wurde er entdeckt?
- Welche bereits durchlaufenen Prozessschritte verursachten dadurch erneut Arbeit?
- Wie viele Minuten Aufwand entstanden in diesen Schritten?
- Wäre der Fehler grundsätzlich automatisch erkennbar gewesen?
Damit lässt sich der Aufwand für späte Korrekturen im eigenen Prozess abschätzen.
In einer vereinfachten Betrachtung:
Kosten für späte Korrekturen = (Anzahl der Fehler × durchschnittlich erneut betroffene Prozessschritte × durchschnittlicher Aufwand je Schritt in Minuten × Vollkostensatz pro Stunde) / 60
Für die Bewertung einer automatisierten Qualitätssicherung ist insbesondere der Anteil des gemessenen Aufwands relevant, der auf automatisiert erkennbare Fehler entfällt.
Nach einigen Wochen entsteht so eine belastbare Ausgangsbasis für den eigenen Business Case.
Projekt-, Lizenz- und Betriebskosten müssen einem möglichen vermiedenen Aufwand natürlich gegenübergestellt werden.
Ggf. kann auch die Wertigkeit einer höheren Content-Qualität in die Bewertung einfließen. Allerdings ist diese subjektiv und damit nicht belastbar.
Die Workflow-Automatisierung kann weitere Aufgaben übernehmen
Die automatisierte Sprachprüfung ist ein konkreter Anwendungsfall. Das technische Prinzip lässt sich auch für weitere Aufgaben einsetzen.
Ein ST4-Workflow kann einen definierten Prozess anstoßen, darin Congree-Funktionen verwenden und anschließend Informationen nach SCHEMA ST4 zurückschreiben oder Daten an Congree übergeben.
So können beispielsweise Termkandidaten automatisch ermittelt und an Congree übergeben werden. Dadurch ist die Übergabe nicht mehr von einem manuellen Arbeitsschritt abhängig und kann im vorgesehenen Prozess nicht vergessen werden. Ebenso lassen sich freigegebene Sätze automatisch an ein Authoring Memory übergeben.
Welche Automatisierungen sinnvoll sind, hängt vom jeweiligen Redaktionsprozess ab. Ein guter Ausgangspunkt sind klar abgegrenzte Aufgaben, die regelmäßig anfallen und heute manuell ausgeführt werden.
Fazit
Automatisierte Qualitätsprüfung kann dort entlasten, wo Anforderungen eindeutig und maschinell prüfbar sind. Verstöße gegen Strukturregeln, Terminologie sowie viele sprachliche und stilistische Vorgaben müssen dann nicht erst im Lektorat oder in späteren Prozessschritten auffallen. Das spart Zeit und Geld.
In SCHEMA ST4 lassen sich solche Prüfungen direkt in den Redaktionsprozess integrieren. Sie werden an definierten Stellen automatisch ausgeführt, ihre Ergebnisse stehen dem Workflow zur Verfügung und können weitere Aktionen auslösen.
Automatisierte Prüfungen helfen dabei, die Einhaltung definierter Qualitätsvorgaben zuverlässiger zu kontrollieren. Es bleibt mehr Zeit für Aufgaben, bei denen fachliches Wissen und menschliche Beurteilung erforderlich sind.
tl;dr
Automatisierte Qualitätsprüfung kann dort entlasten, wo Anforderungen eindeutig und maschinell prüfbar sind. Verstöße gegen Strukturregeln, Terminologie sowie viele sprachliche und stilistische Vorgaben müssen dann nicht erst im Lektorat oder in späteren Prozessschritten auffallen. Das spart Zeit und Geld.
