Inhaltsverzeichnis
Haben Sie sich auch schonmal gefragt, was sich hinter dem Reiter „Reporting“ in der obersten Leiste von SCHEMA ST4 verbirgt? Es steckt mehr dahinter, als es auf den ersten Blick scheint. Reports in SCHEMA ST4 bieten Technischen Redakteurinnen und Redakteuren hilfreiche Features für die tägliche Arbeit mit dem Contentmanagement-System. Deshalb werfen wir jetzt gemeinsam einen Blick auf die Hilfe, die uns hier etwas versteckt geboten wird.
Was sind Reportings in SCHEMA ST4?
Ein ST4-Report ist eine Auswertung ausgesuchter Inhalte, an deren Ende ein Bericht steht. Es gibt verschiedene Formen von Auswertungen und damit Reports. Geprüft werden dabei grob zusammengefasst zwei Punkte:
- der strukturelle Aufbau, also so etwas wie Knotenstruktur, Eigenschaftenschlüsselung etc. oder
- der geschriebene Content an sich.
Am Ende steht eine Auflistung entsprechender Knoten, je nach Report im Meldungs-Viewlet oder im Report-Viewlet selbst.
Die verschiedenen Reports in ST4 können mit ihren Auswertungen verschiedene Funktionen erfüllen: Sie können der Prozesssteuerung dienen, können Kennzahlen und Objektlisten für eine Arbeitsprozess-Optimierung liefern, können systemweite Eingriffe ermöglichen (um z. B. ein bestimmtes Metadatum in vielen Knoten zu setzten) oder können Inhalte und Strukturen prüfen, um die Qualität der Dokumente sicherzustellen.
Vielleicht ist Ihnen auch schon einmal der Begriff generische Reports in SCHEMA ST4 begegnet. Das sind spezielle Reports, die komplexer sind als die Standard-Reports. Hier heißt es selbst Hand anlegen, vergleichbar mit dem Erstellen eigener Schematron-Regeln. Wenn Sie zu diesem Thema mehr erfahren wollen, dann empfehle ich Ihnen unser Webinar „Von der Schnellsuche bis zum generischen Report in SCHEMA ST4“.
Die standardmäßig verfügbaren Reports decken aber schon ein sehr breites Spektrum ab; zu viel, um alle hier auszuführen. Deswegen konzentrieren wir uns auf einen sehr entscheidenden Punkt in der technischen Doku: die Qualitätssicherung.
SCHEMA ST4-Reports im praktischen Einsatz
Reports sind für die Qualitätssicherung so etwas wie ein Schweizer Taschenmesser im CMS – immer dabei, schnell zur Hand und ungemein praktisch. Ich zeige Ihnen hier zwei Beispiele, die Sie out-of-the-box ohne Vorkenntnisse anwenden können.
Ähnliche-Knoten-Report
Bei der Arbeit an einer Dokumentation stellen Sie sich vielleicht nach einiger Zeit die Frage, ob alle Inhalte konsistent geschrieben sind und ob Sie Teile im Projekt wiederverwenden können. Der Ähnliche-Knoten-Report findet hier für Sie Knoten, die einem Referenzknoten (genannt Wurzelknoten) ähnlich sind.
Der Ähnliche-Knoten-Report in SCHEMA ST4: Ähnliche Knoten zu einem Wurzelknoten werden in einer Rangfolge aufgelistet
Für den Report wählen Sie einen Wurzelknoten aus und ST4 vergleicht Knoteninhalte, Knotentitel, Kommentare und andere Knoteneigenschaften mit anderen Knoten und vergibt aufgrund der Ähnlichkeit einen Rang. Im Report-Viewlet finden Sie dann ähnliche Knoten nach Rang gelistet. Die Knoten müssen sich also nicht eins-zu-eins gleichen, um in der Liste aufgeführt zu werden.
Ein sehr hoher Rang kann ein Indiz dafür sein, dass bestimmte Absätze durch vorhandene Fragmente ersetzbar sind und hier redundante Datenhaltung vermieden werden kann. Durch diesen Report fallen auch ungewollte textliche Varianzen auf, die Sie dann leicht vereinheitlichen können.
Eigenschafts-Report
Stellen Sie sich vor, Sie verwalten Rezepte in ST4. Hier finden sich Rezepte, die Sie aus unterschiedlichen Quellen zusammengetragen haben. Um den Überblick zu behalten, haben Sie ein Metadatum „Lieferant“ vergeben. Nach einiger Zeit stellen Sie fest, dass Ihre Einteilung nicht so richtig passt und Sie gerne Knoten mit der Eigenschaft „Lieferant ist Nachbar“ einem anderen Lieferanten zuordnen wollen. Und haben eigentlich alle Rezepte diese Eigenschaft? Da diese Eigenschaft für Ihre Produktion wichtig ist – z.B. Ausgabe als Progressive Web-App, bei der die Rezepte auch nach Lieferant gefiltert werden sollen – sollte bei allen Knoten das Metadatum befüllt sein.
Der Eigenschafts-Report ist hier ein schneller und zuverlässiger Weg, beide Problem zu lösen.
Sie legen einen Wurzelknoten (Ordner, Projekt oder Textknoten, bei uns „Kuchendaten“, siehe Abbildung unten) fest und wählen die relevanten Eigenschaften aus der Liste aus (siehe Abbildung, hier Lieferant). Nach der Ausführung wird im Report-Viewlet eine Tabelle ausgegeben, die neben Knotentiteln und ID auch die ausgewählten Eigenschaften anzeigt. Für die Anzeige können Sie wählen, ob alle Knoten angezeigt werden sollen oder z. B. nur die, für die die Eigenschaft definiert und befüllt ist.
In unserem Beispiel können Sie schnell zum Knoten mit der Nummer 69830411 springen und das Metadatum anpassen. Und ein kurzer Check zeigt: alle Knoten haben die Eigenschaft Lieferant.
Eigenschaften-Report in SCHEMA ST4: Für einen Wurzelknoten werden ausgewählte Eigenschaften tabellarisch aufgelistet
Ein weiteres Beispiel wären Dokumente, die eine Vielzahl an Fußnoten enthalten, dieser Fragmenttyp soll aber in der aktuellen Produktion nicht mehr vorkommen. Auch hier können Sie im Report über eine Eigenschaft „Fragmenttyp“ gezielt Knoten ansteuern, die noch den Wert „Fußnote“ gesetzt haben und diese korrigieren.
Sie sehen: Beide Reports lassen sich auf vielfältige Weise zur Qualitätssicherung einsetzen. Nutzen Sie selbst schon die Reports in SCHEMA ST4? Welche Erfahrungen haben Sie damit schon gemacht?
