Standardisierung, Modularisierung und Klassifizierung in der Technischen Dokumentation – Was ist was?

Was empfinden Sie beim Anblick dieser Bilder? Wenn Sie das linke Foto in ähnlichem Maße aufregt, wie Ihnen das rechte Bild Freude bereitet, sind Sie in der Technischen Redaktion gut aufgehoben. So wie ein perfekt beladener Geschirrspüler das beste Reinigungsergebnis ermöglicht, pflegen Redaktionen ihren Content akribisch, um das Maximum herauszuholen. Und damit ist mehr gemeint als nur die Optik.

Wir nutzen Werkzeuge wie Standardisierung, Modularisierung und Klassifizierung, um verständliche, sichere und kostensparende Dokumentationen anzufertigen. Gleichzeitig legen wir damit die Basis für intelligente Informationen und Automatisierungen. Was diese Begriffe bedeuten und welche Rolle Metadaten dabei spielen, sehen wir uns hier genauer an.

Standardisierung

Standardisierung bedeutet, bestimmte Regeln festzuhalten und diese auch umzusetzen. Um bei unserem Beispiel zu bleiben: Beim Einräumen des Geschirrspülers werden Sie wahrscheinlich Gläser und Tassen immer mit der Öffnung nach unten anordnen. Sie folgen also – standardmäßig – einer Regel, die einem bestimmten Zweck dient: sauberes und trockenes Geschirr.

Wozu wir im redaktionellen Kontext standardisieren, wurde bereits erwähnt: Wir möchten Dokumentationen produzieren, die es den Anwenderinnen und Anwendern ermöglichen, ein Produkt sicher zu nutzen. „Sicher“ heißt auch, dass die Inhalte so präzise wie nötig und so verständlich wie möglich gestaltet werden. Komplexer Satzbau oder mit Warnungen voll gepflasterte Seiten sind hier kontraproduktiv. Also legen wir Regeln für Sprache und Struktur fest, die das verhindern sollen und uns stattdessen helfen, unsere kommunikativen Ziele zu erreichen.

Und natürlich sollen auch Ressourcen gespart werden: Wenn ich nicht bei jedem kleinen Schritt überlegen muss, wie ich ihn tue, sondern mich an Vorgaben halten kann, geht die Arbeit schneller von der Hand und der Abstimmungsaufwand sinkt merklich.

Bei der Standardisierung spielt natürlich auch die Terminologie eine wichtige Rolle, die im Idealfall unternehmensweit einheitlich ist.

Auch wenn wir uns hier bei unseren Begriffsdefinitionen auf redaktionelle Inhalte konzentrieren: Die Standardisierung bezieht sich ausdrücklich nicht nur auf Inhalte, sondern genauso auf Prozesse, die in der Technischen Redaktion und im Unternehmen standardisiert, einheitlich und nachvollziehbar ablaufen sollen.

Modularisierung

Und damit sind wir auch schon bei der nächsten Fachvokabel: Modularisierung bedeutet das Aufsplitten unserer (standardisiert erstellten) Inhalte in funktionale Einheiten. Für diese Bausteine gibt es verschiedene Bezeichnungen: Knoten, Informationseinheiten, Topics – oder eben Module. Wir können ein ganzes Kapitel wie z. B. eine Einleitung als Baustein betrachten oder Zwischenüberschriften, Grafiken und Textabschnitten als Module festlegen. Selbst bis auf Wortebene können wir unsere Inhalte „zerkleinern“. Wie stark Sie Ihre Inhalte modularisieren, hängt von vielen Faktoren ab. Wenn Sie zu diesem Thema weiterlesen wollen, empfehle ich Ihnen unseren Blogartikel „Modularisierung in der Technischen Dokumentation“ oder unserem FreebieWebinar „Modularisierung im CMS“.

Was gewinnen Sie dadurch? Ihre Bausteine können Sie an unterschiedlichen Stellen der Dokumentation wiederverwenden. Sie sparen dadurch Zeit und Geld, Ihr Inhalt wird konsistenter und Sie vermeiden Fehlerquellen. Mit standardisierten und modularisierten Inhalten reduzieren auch deutlich die Kosten für Übersetzungen. Und schließlich sind Sie flexibler, wenn es an die Ausgabe Ihrer Inhalte geht – dazu brauchen Sie aber noch den nächsten Schritt …

Klassifizierung durch Metadaten

Ihre Module verwalten Sie am besten in einem Redaktionssystem. Hier stellen Sie fertige Dokumentationen für verschiedene Ausgabemedien zusammen. Aber woher weiß das CMS eigentlich, wann welches Modul für eine Produktion verwendet werden soll? Schließlich passt nicht jeder Baustein auch wirklich zu jedem Produkt oder zu jeder Zielgruppe. Hier kommt die Klassifizierung ins Spiel.

Das Zuweisen von bestimmten Eigenschaften zu einem Baustein bezeichnen wir als Klassifizierung. Und die Eigenschaften heißen in unserer Branche Metadaten. Von „Meta“ sprechen wir, weil es sich um Daten über Daten handelt. Mit Metadaten können wir also den Inhalt, die Zielgruppe oder die Funktion eines Bausteins näher beschreiben oder ihn einem bestimmten Produkttyp zuordnen.

Für einen Teller aus unserem top-eingeräumten Geschirrspüler könnten wir unter anderem das Metadatum „tief“ für die Eigenschaft „Form“ festlegen. Oder wir erfassen die Zielgruppe „Kinder“ oder dass er im Küchenschrank hinten links gelagert wird … oder was immer im konkreten Fall nützlich ist.

Ein Redaktionssystem kann nun Bausteine anhand dieser Eigenschaften in eine Produktion ein- oder ausschließen. In verschiedenen Filtern legen wir die Eigenschaften fest, die Module aufweisen müssen, um ausgegeben zu werden. So gelangen wir schließlich mit standardisierten, modularisierten und klassifizierten Bausteinen zu unserem Ziel: Den passenden Inhalt zur richtigen Zeit an die richtige Person auszuspielen und das mit so wenig Aufwand wie möglich. Diese Ausgabe kann eine komplette Dokumentation für ein Produkt sein, eine Onlinehilfe zu einer Fehlermeldung oder eine Anzeige auf einem Display für das Servicepersonal.

Wenn das Fundament stimmt, ist vieles möglich

Mit der richtigen Basis aus Standardisierung, Modularisierung und Klassifizierung legen Sie nicht nur die Basis für Ihr Contentmanagement, sondern stoßen die Türen in Richtung intelligente Information und Digitalisierung weit auf. Wer mit seinen Inhalten hoch hinaus will, der muss für ein solides Fundament sorgen.