Bei der Erstellung einer XML-Dokumentation können auch den Redakteur:innen Qualitätsfehler unterlaufen. Fehler, die auf den ersten Blick schwer zu erkennen sind.
Anführungszeichen bei mehrsprachigen Dokumentationen
Ein einfaches Beispiel ist die Nutzung von Anführungszeichen bei mehrsprachigen Dokumentationen. Anstelle der Nutzung des vorhandenen Quote-Elementes, welches die Anführungszeichen für jede Sprache richtig setzt, wird oftmals das Anführungszeichen genutzt. So ein Fehler fällt in der Regel erst nach dem Übersetzungsprozess im Zuge der Publikation auf. Solche vermeidbaren Fehler kosten Zeit, Geld und Nerven. Doch wie lassen sich diese frühzeitig erkennen und reduzieren? Eine mögliche und einfache Lösung kann die Etablierung einer Schematron-Prüfung sein, die in den Freigabeprozess integriert wird. Schematron bietet eine kontextabhängige Prüfung anhand von einmal zu definierenden Regeln. Fehler oder Empfehlungen lassen sich in einer lesbaren Form zurückgeben.
Eine Regel für das obige Beispiel könnte wie folgt aussehen
Das Ergebnis der Prüfung könnte wie folgt dem/der Redakteur:in beispielsweise als HTML-Report zur Verfügung gestellt werden:
Nutzen Sie ein Redaktionssystem, könnten Sie die Metadaten der Topics oder Dokumente mit in die Prüfung einfließen lassen. Beispielsweise könnte abhängig von der Dokumentenart geprüft werden, ob bestimmte Inhalte vorhanden sind.
Mit wenig Aufwand viel erreichen
Eine Schematron-Prüfung ist ein sehr mächtiges Werkzeug, welche die Toolbox, bestehend aus DTD/XSD-Prüfung und Autorenunterstützung, gut ergänzt. Mit wenig Aufwand können Sie viel erreichen und automatisiert prüfen.
Schematron wird oftmals unterschätzt
Meines Erachtens wird Schematron noch zu wenig genutzt. Vielleicht ist es vielen auch unbekannt. Im Umfeld der S1000D-Welt ist die Schematron-Prüfung in Form der Business Rules (BREX) ein fester Bestandteil der Qualitätskontrolle.
Wie sieht es bei Ihnen aus? Nutzen Sie bereits die Schematron-Prüfung und welche Erfahrungen haben Sie gemacht?