Varianten im Griff
Ursachen für die verschiedenen Varianten in der Technischen Dokumentation gibt es viele. Doch wie bekommt man als Technische Redaktion die Variantenvielfalt am besten in den Griff. Stefan Gruber-Barowitsch – Berater für Technische Kommunikation und Quanos-Partner aus Graz – hat uns seine Vorgehensweise verraten, wie er unterschiedliche Varianten on der Dokumentation identifiziert.
Das Modell geht bei der Identifizierung der Varianten in mehreren Stufen vor. Sobald die verschiedenen Varianten identifiziert sind, lassen sie sich in den Redaktionsumgebungen als Contentmodule ausgliedern und verwalten. Für Technische Redaktionen bietet dieses Modell den Vorteil, dass sich der Detailierungsgrad der Analyse auf die Bedürfnisse und Möglichkeiten jeder Redaktion individuell abbilden lässt. Nicht jede Redaktion kann die gleiche Zahl an Varianten bewältigen. Was möglich ist, hängt unter anderem ab von den dokumentierten Produkten, den personellen Ressourcen und natürlich auch vom verwendeten Redaktionssystem.
Stufe 0 - Bestandsaufnahme
Wie sieht nun dieses Modell aus? Ganz am Anfang steht Stufe 0, der Standard, der bereits in der Redaktion vorliegt. Denn fast jedes Unternehmen hat bereits verschiedene Dokumentationsvarianten und verwaltet diese auch in irgendeiner Form. Oft geschieht das durch die Ablage im Dateisystem oder durch eine Excelliste, in der die Unterschiede zwischen den verschiedenen Anleitungen vermerkt sind.
Stufe 1 - Kapitel
Auf Stufe 1 geht es dann ganz pragmatisch erst einmal darum, welche Kapitel in allen Anleitungen vorhanden sind und wie sich eine einheitliche Struktur herstellen lässt. Am besten orientiert man sich hier am Inhaltsverzeichnis der verschiedenen Anleitungen und markiert sich dann, welche Textteile gleich bzw. verschieden sind. Es geht hier darum zu identifizieren, welche Kapitel komplett identisch sind. Diese Kapitel können Sie dann als Standardkapitel für Ihre Dokumentation vorhalten.
Stufe 2 - Zusätzliche Kapitel
In Stufe 2 ermitteln Sie nun, ob es Kapitel gibt, die für einige Varianten zusätzlich zum Standard hinzukommen. Wir bewegen uns hier immer noch auf Kapitelebene; es geht nur darum, zusätzliche, optionale Textteile zu identifizieren.
Stufe 3 - Spezifische Teile von Kapiteln
Erst in Stufe 3 sehen Sie sich die Inhalte genauer an. Lassen sich geschlossene Teile innerhalb eines Kapitels identifizieren, die nur für manche Varianten ergänzt werden? Diese Teiltexte können dann ebenfalls als Standards ins Variantenmanagement aufgenommen werden.
Stufe 4 - Kleinere Elemente
Stufe 4 nimmt nun kleinere Elemente in den Blick. Welche Abbildungen, Beschreibungen von Displays, etc. sind in allen Anleitungen identisch, wo soll mit Symbolabbildungen gearbeitet werden, wo müssen Abbildungen und Abbildungsbeschriftungen getauscht werden?
Stufe 5 - Varianz auf Zeichenebene
Auf Stufe 5 sind wir zu guter Letzt auf der Zeichenebene angelangt. Manche Textteile sind weitgehend identisch, allerdings müssen einige wenige Zeichen ausgetauscht werden. Typischer weise sind das Produktdaten oder -bezeichnungen. Viele Redaktionen fassen der Einfachheit halbe alle Produktdaten für alle Produkte in einer Tabelle für Technische Daten zusammen. Das kann aber schnell unübersichtlich werden. Mit der richtigen Redaktionssoftware ist es deshalb oft die bessere Lösung die Produktdaten in Variablen vorzuhalten und an den entsprechenden Stellen zu tauschen.
Mit diesem Vorgehen lassen sich die Varianten auf verschiedenen Ebenen der Dokumentation gut identifizieren. Zu guter Letzt aber noch ein kurzer Blick auf die Frage nach dem Sinn des ganzen Variantenmanagements: Lohnt sich denn der Aufwand, der dafür betrieben werden muss? Bisher ging es doch auch immer irgendwie! Sicher, im Allgemeinen kommt man irgendwie zurecht. Aber mit sinnvollem Variantenmanagement erreichen Sie viele Ziele gleichzeitig. Ihre Anleitungen werden einheitlicher. Sie sind dadurch leichter zu übersetzen. Der Pflegeaufwand sinkt, da immer nur an einer Stelle geändert werden muss. Gleichzeitig sinkt auch Ihre Time-to-Market. Sobald klar ist, wie eine neue Produktvariante gestaltet werden soll, können Sie anhand der bestehenden schnell die dazugehörige Dokumentation ableiten und bestimmen, wie hoch der Aufwand für die neue Anleitung sein wird. Mit einem systematischen Variantenmanagement profitieren Sie also auf vielen verschiedenen Ebenen. Sie müssen nur noch entscheiden, wie detailliert ihr Variantenmanagement sein kann.
Sie möchten es noch genauer wissen?
Wenn Sie das Vorgehen von Stefan Gruber-Barowitsch begeistern konnte, sie es aber auch mal in Aktion und detaillierter sehen möchten, sollten Sie sich die Aufzeichnung unseres Webinars ansehen. Darin zeigt Herr Gruber-Barowitsch ganz praxisnah, wie Varianten von Stufe 0 bis 5 identifizieren.
Und wenn Sie noch mehr über gelungenes Variantenmanagement erfahren möchten, dann schauen Sie doch auf userer Themenseite Variantenmanagement vorbei.
Andere Artikel von Quanos
Das könnte Sie auch interessieren
Die perfekte Technische Dokumentation
Perfekt ist natürlich niemand, auch keine Dokumentation. Aber man wird ja noch träumen dürfen. Wie sähe sie denn aus,…
1 – 2 – Callout! Grafikbeschriftung leicht gemacht
Technische Dokumentation, das heißt meistens: Viele Bilder. Denn immer wieder muss man zeigen, welches Produktbestand…
Redaktionsleitfaden, Styleguide oder Redaktionshandbuch in der Technischen Redaktion
Redaktionshandbuch, Styleguide, Schreibleitfaden – in fast jeder Technischen Redaktion gibt es ein oder mehrere Dokum…