Technische Dokumentation von Produktvarianten durch Einsatz von Varianten und Variablen erleichtern
Jede technische Dokumentation richtet sich an dem Produkt aus, das sie beschreibt. Nun gibt es aber von nahezu jedem Produkt Varianten, die mehr oder weniger ausgeprägt sind und dementsprechend ins Gewicht fallen. Das können einfache Varianten sein wie unterschiedliche Gehäusefarben, aber auch komplexere wie länderspezifische Faktoren, etwa verschiedene Bedienungssprachen in einem ansonsten baugleichen Smartphone. Und selbstverständlich tauchen auch zahlreiche Kombinationen von Varianten auf. Es stellt sich also die Frage: Wie bringt man als Redakteur Varianten so in eine technische Dokumentation, dass das Management übersichtlich bleibt und Fehlerquellen möglichst ausgeschaltet werden?
Produktvarianten dokumentieren
Nehmen wir an, ein Hersteller bringt ein Produkt aus Imagegründen unter den vier Modellbezeichnungen A, B, C und D auf den Markt. Einen Unterschied gibt es nur in den Bezeichnungen, ansonsten sind alle Produkte identisch. Für jedes Modell gibt es eine technische Dokumentation, deren Inhalte bis auf den Namen ebenfalls identisch sind. Sie benötigen also nur ein Original – etwa für Modell A – und drei Kopien für B, C und D. In diesem Fall ist das Variantenmanagement relativ leicht zu handhaben. Schwierig wird es, wenn dem Hersteller im Laufe der Zeit einfällt, die Produkte individuell zu verändern. Beispielsweise wird Modell B gerne von älteren Menschen gekauft, Produkt D dagegen von Jugendlichen, aus welchen Gründen auch immer. Nun werden diese beiden Modelle durch leichte Detailänderungen an die beiden Zielgruppen angepasst, um den Absatz weiter zu steigern. Die Zahl der Varianten wächst, die Anzahl der Anleitungen somit auch. Kommen weitere Änderungen hinzu, hat nach einer Weile niemand mehr den Überblick, welche Änderung sich auf welche technische Dokumentation auswirkt. Parallel steigt der Arbeitsaufwand, da die Relevanz der Änderungen stets für mehrere oder alle Dokumente überprüft werden muss. Nach zwei oder drei Jahren ist das Chaos perfekt.
Nutzen Sie Variablen!
Jedes moderne Textprogramm, mit dem Sie Ihre technische Dokumentation verfassen, ist in der Lage, mit Variablen zu arbeiten. Manche Variablen sind vom Programm definiert wie „aktuelles Datum“ oder „Uhrzeit“. In unserem Fall handelt es sich bei den Variablen um mehr oder weniger lange, benutzerdefinierte Textabschnitte, die bei Bedarf in andere Texte eingefügt werden können. Jede Variable bekommt einen, nach Möglichkeit semantisch sinnvollen Namen und eine Definition. Letztere enthält den Text und seine Formatierung. Für die technische Dokumentation können Variablen verwendet werden als:
- einzelne, austauschbare Begriffe wie Produktbezeichnungen,
- Container für verschiedene Metadaten,
- Textpassagen, die in Übersetzungen ausgetauscht werden,
- immer wieder auftauchende Textbausteine,
- Erläuternde Texte, die das Produkt auf seinem Display selbst hervorbringt, wenn gewisse Eingaben erfolgt sind u. v. m.
Einzelne Bausteine erleichtern die Dokumentation
Mit Variablen und Varianten in Verbindung mit moderner Hard- und Software lassen sich heute komplexe technische Dokumentationen wesentlich präziser modularisieren, als dies früher – wenn überhaupt – der Fall war. Durch die mögliche Filterung etwa nach Produkt-, Zielgruppen- oder Sprachvarianten wird anschließend das Publizieren von Anleitungsvarianten stark vereinfacht. Wichtig ist dabei ein ausgeklügeltes Konzept, an das sich eine Redaktion jederzeit sicher halten kann, eine konsequente Pflege des Variantenmanagements und die Bereitstellung von Metadaten, mit denen sich die einzelnen Module identifizieren und klassifizieren lassen. Entscheidend sind hier die richtigen Zuordnungen zum Hersteller, zum Gerät und seiner Variante, zu Komponenten und Funktionsgruppen genauso wie die Zielgruppen, Sprachen und Informationstypen.
