Varianten existieren sowohl in der Produktwelt als auch in der technischen Dokumentation. Technischen Redakteuren stehen unterschiedliche Möglichkeiten zur Verfügung, um der Vielzahl an Varianten Herr zu werden und mit ihnen effizient zu arbeiten. In meinem ersten Beitrag zum Themengebiet „Varianten in der technischen Dokumentation“ habe ich den Einsatz von Variablen diskutiert. Diese sind geeignet, kleinere Unterschiede zwischen Dokumenten zu steuern. In der technischen Dokumentation differenzieren Texte häufig nicht nur durch verwendete Produktnamen oder Leistungsangaben. Dann stoßen wir mit dem Werkzeug „Variablen“ an Grenzen. Dieser Beitrag ist der Bedeutung und dem Einsatz von der Funktion „Bedingter Text“ in Adobe FrameMaker gewidmet.
Maschine mit zwei Varianten
Am Besten verdeutliche ich das Vorgehen anhand eines Beispiels:
Eine Maschine wird in zwei Versionen ausgeliefert. Variante A ist eine Maschine mit einem integrierten Display und die Variante B ist die gleiche Maschine nur ohne Display dafür mit einer Schnittstelle für eine externe Steuereinheit. Der Aufbau, die Funktion wie auch die technischen Daten der beiden Maschinenvarianten sind gleich. Sie werden aber in unterschiedlicher Art und Weise in Betrieb genommen und bedient. Ebenso unterscheiden sich die Varianten in ihrem Produktnamen.
Für jede Variante eine Anleitung
Die technische Redaktion soll für jede Produktvariante eine Betriebsanleitung schreiben. Einige Kapitel der beiden Anleitungen (z. B. Einleitung, Sicherheit, Funktionale Beschreibung) werden bis auf die Produktbezeichnung identisch sein. Andere Kapitel (z. B. Installation, Inbetriebnahme, Bedienung) werden stärker differenzieren.
Eine Datei in zwei Büchern
Eine mögliche Vorgehensweise für die Redakteure ist, dass gleiche Kapitel von einer Anleitung in die andere übernommen werden und die Variablendefinition entsprechend des Produktnamens geändert wird. Demnach würde die FrameMaker-Datei Einleitung sowohl in dem Buch der Maschine mit Display (Anleitung Variante A) und in dem Buch der Maschine ohne Display (Anleitung Variante B) eingesetzt werden.
Quasi gleich Kapitel
Bei genauerer Untersuchung lässt sich feststellen, dass sich das Kapitel Installation für beide Maschinenvarianten nur durch eine Handlung unterscheidet. Wird die Maschinen ohne Display installiert, muss auch die Leitung der externen Steuereinheit angeschlossen werden. Diese Handlung entfällt bei der Installation der Maschine mit integriertem Display. Vorstellbar wäre, dass der Redakteur das Installationskapitel für die eine Variante schreibt, dann dieses Kapitel kopiert und für die zweite Variante anpasst. Auf diese Weise würden zwei Dokumente (ein Originalkapitel und eine Kopie) entstehen. Es müssten immer zwei Dokumente übersetzt und gepflegt werden. Also wäre dieses Vorgehen nicht sehr effektiv.
Bedingungen im FrameMaker
Adobe FrameMaker bietet mit der Funktion „bedingtem Text“ eine Möglichkeit, in einem Dokument (häufig als Masterdokument bezeichnet) sowohl Textteile, der für alle Varianten gilt, als auch Texteile zu erfassen, der nur für einzelne Variante gültig ist. Auf diese Weise können mehrere Varianten einer Dokumentation in einem Dokument geschrieben und verwaltet werden.
Mit einer Bedingung können Texte, Grafiken (sofern sie verankert sind), Tabellen oder auch Gleichungen versehen werden. Die kleinste Einheit für bedingten Text sollte ein vollständiger Satz einschließlich Satzzeichen sein. Kleinere Einheiten können beim Übersetzen Schwierigkeiten bereiten. Bedenken Sie, dass sich die Wortfolge während der Übersetzung häufig ändert, daher kann eine Bedingungen für nur einen Teil eines Satzes die Übersetzung erschweren.
In dem Beispiel gäbe es eine FrameMaker-Datei „Installation“. In dieser Datei werden alle Handlungen für die Installation beider Maschinenvarianten erfasst. Ebenso wird in der Datei die Handlungssequenz „Externe Steuereinheit anschließen“ beschrieben, die nur für die Maschine ohne Display (Variante B) gültig ist. Dieses Unterkapitel wird im FrameMaker mit einer Bedingung belegt.
Vorgehensweise FrameMaker
- Menü Spezial > Bedingter Text
Horizontaler Pod öffnet sich. - Schaltfläche „Neues Tag erstellen“.
- Eigenschaften definieren, z. B. blaue Hintergrundfarbe.
- Schaltfläche „Hinzufügen“.
Bedingungsformate zuweisen:
- Zu bedingenden Inhalt markieren.
- Im horizontalen Pod: „Eingeschlossen“ auswählen.
Dabei wird automatisch auch „Bedingt“ aktiviert. - Gewünschte Bedingung anklicken.
- Schaltfläche „Anwenden“ drücken.
Konzept für Bedingungen
Wenn Sie Bedingungen in Ihre Dokumentation einführen, sollten Sie sich im Vorfeld ein paar Gedanken machen. Dabei ist zu berücksichtigen, welche Textbestandteile sollen mit der Funktion „Bedingter Text“ gesteuert werden und warum. Nur wenn Sie die bedingten Text einheitlich behandeln, unterstützt dieses Werkzeug Ihre Arbeit. Legen Sie die Regeln für die Benennung und Anwendungen der Bedingungen in einem Redaktionsleitfaden ab.
Fazit
Unterscheiden sich Texte durch einzelne Begriffe wie Produktnamen oder durch einzelne Leistungsangaben, dann können diese Textvarianten mit Hilfe von Variablen gesteuert werden. Sind die Unterschiede von den Texten größer, wie in dem Beispiel eine Handlungssequenz „Externe Steuereinheit anschließen“, dann hilft die Funktion „Bedingter Text“ des FrameMakers weiter.
Hinweis
Variablen im FrameMaker für die Steuerung von Varianten in der technischen Dokumentation siehe mein erster 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.