Varianten existieren in verschiedenen Ausprägungen: produktspezifische Varianten, kundenspezifische Varianten, länderspezifische Varianten und zielgruppenspezifische Varianten und beliebige Kombinationen kommen ebenso vor. Welche Auswirkungen haben Varianten der Produktwelt auf die technische Dokumentation? Dieser Beitrag geht dieser wie auch den Fragen nach: Wie wir als technische Redakteure dieser Vielfalt begegnen, und wie wir die Übersicht behalten können?
Beispiel: Produktvariante
Um sich den Fragen und ihren Antworten zu nähern, gehe ich von einem konstruierten Beispiel aus: Zwei Produkte sind sich sehr ähnlich. Sie sind zum Beispiel gleich groß, aber haben unterschiedliche Leistungsangaben. Oder die Produkte sind identisch, aber werden unter verschiedenen Produktnamen vertrieben. Diese Umstände führen dazu, dass es für jedes Produkt eine Anleitung existiert und diese beiden Anleitungen sich nur in einer (oder mehreren) Zahlenangabe(n) oder in einem Namen unterscheiden.
Das Original und seine Kopie
Als Redakteure haben wir die Möglichkeit, die Anleitung des einen der beiden Produktvariante zu kopieren und diese Kopie entsprechend (Leistungsangabe, Produktname) zu ändern. Damit entstehen zwei Anleitungen: das Original und eine Kopie mit Anpassungen. Im Lauf der Entwicklung verändern sich die Produkte. Vorstellbar ist, dass sich nur eine Produktvariante ändert oder auch beide. Entsprechend muss die Redaktion reagieren und die Produktänderung(en) aufnehmen. Solange es zwei Produktvarianten sind, ist dieser Weg ( zwei getrennte Anleitungen) vielleicht umsetzbar. Was passiert, wenn die Variantenanzahl und damit die Dokumentenanzahl steigt? Wer weiß dann noch, auf welche Dokumente sich Änderungen auswirken und auf welche nicht?
Neben der Schwierigkeit den Überblick zu behalten, entsteht auch ein großer Arbeitsaufwand. Es müssen immer in mehreren Dokumenten geprüft werden, ob die Änderung relevant ist. Anschließend sind die entsprechenden Dokumente anzupassen. Auf diese Weise entstehen immer mehr Varianten der Original-Anleitung. (Stichwort unkontrollierte Redundanz).
Variablen helfen
Alternativ können technische Redakteure die Vorteile ihres Programmes nutzen. Ob Word oder FrameMaker oder ein anderes Programm, sie bieten die in der Regel die Möglichkeit, Variablen einzusetzen.
Was ist eine Variable?
Eine Variable ist ein Textstück, was immer an verschiedenen Stellen eines Textes oder unterschiedlicher Texte einsetzbar ist.
Variablen werden sehr unterschiedlich eingesetzt, zum Beispiel:
- Für Wörter, die flexibel austauschbar sein sollen, zum Beispiel Firmen- oder Produktnamen.
- Für Texte, die für Übersetzungen immer gleich ausgetauscht werden sollen, zum Beispiel Sprachangaben in Griffregistern.
- Als Container für Metadaten, die im Dokument selbst nicht dargestellt werden sollen, zum Beispiel Template-Version, Telefonnummern.
- Für Texte, die den zu dokumentierenden Produkten entnommen werden, zum Beispiel Display-Texte.
- Für Ausdrücke, die im Text immer gleich lauten sollen, wie „Nehmen Sie mit dem Service Kontakt auf.“ Bitte beachten Sie, dass Sie hier nur ganze Sätze als Variable fassen, da es sonst zu Schwierigkeiten im Übersetzungsprozess kommt.
Eine Variable besteht aus einem Namen und einer Definition. Eine Definition enthält den Text und das Zeichenformat des Textes. Wenn Sie eine Variablendefinition bearbeiten, werden alle Vorkommen der Variablen im Dokument aktualisiert.
Variablen im FrameMaker
FrameMaker unterscheidet zwischen Systemvariablen und benutzerdefinierte Variablen. Systemvariablen befüllen sich aufgrund einer entsprechenden Definition wie dem aktuellen Datum vom Programm selber. Im Gegensatz zu den Systemvariablen sind benutzerdefinierte Variablen nicht dynamisch, sondern erhalten ihren Wert vom Benutzer vorgegeben.
Der Austausch der Variableninhalte zwischen Dokumenten wird durch den Formatimport erleichtert. Empfehlenswert ist, spezielle Dateien (Variablen- oder Steuerdatei genannt) anzulegen, in denen die Variablen und ihre Definition festgehalten werden. Mit Hilfe der Funktion „Datei > Importieren > Formate“ können die Variableninhalte der Steuerungsdatei in alle Dokumente eines Buchs importiert werden.
Scripte können helfen
Für automatische Updates können Plug-ins oder FrameScript-Scripte verwendet werden. Weitere Informationen zu Scripten finden Sie unter FrameScript/Elmscript. Das Münchener Unternehmen itl biete Ihnen nach einer Registrierung verschiedene FrameScripte an.
Ausblick
In einem weiteren Beitrag beleuchte ich die Verwendung der Funktion “Bedingter Text” im Adobe FrameMaker. In der technischen Dokumentation differenzieren Texte häufig nicht nur durch verwendete Produktnamen oder Leistungsangaben und dann kommen wir mit Werkzeug Variablen an Grenzen, dann kann die Funktion „bedingter Text“ sehr hilfreich sein.
Hinweis
Die hilfeiche Funktion „bedingter Text“ von Adobe FrameMaker behandele ich in meinem zweiten Beitrag zum Thema.
AXCM ein Plug-In, das die Verwaltung und die Steuerung von Varianten in einer XML-Umgebung unterstützt steht im Zentrum meines dritten Beitrag zum Thema.