Sicherheit aus einer Quelle

Sicherheitshinweis als Texteinschub

Ein Dokument unterliegt in seinem Lebenszyklus stetigen Änderungen. Es lohnt sich daher, wiederkehrende Elemente wie Sicherheitshinweise getrennt abzulegen und sie als Texteinschub in das Dokument zu referenzieren. Der Technische Redakteur ändert einen Sicherheitshinweis zentral für das gesamte Dokument.

Ein Texteinschub ist der Inhalt eines konkret benannten Textflusses aus einer bestimmten Datei. Wird in einem Dokument ein Texteinschub als Referenz eingefügt, dann ist der Inhalt mit der Quelldatei verknüpft und kann auch nur dort bearbeitet werden.

Durch das Abspeichern der Sicherheitshinweise als Texteinschübe bietet sich außerdem die Möglichkeit, deren Formulierung zu vereinheitlichen und damit die Varianten der abgespeicherten Sicherheitshinweise zu reduzieren.

Voraussetzungen treffen

Sollen die einmal separierten Sicherheitshinweise in verschiedenen Dokumentationsarten oder in unterschiedlichen Layouts verwendet werden, dann ist der Einsatz der Texteinschübe nur dann hilfreich, wenn sich die Textformatierung automatisch an das aktuelle Layout anpasst.

Um das zu erreichen, müssen folgende Formatierungsregeln eingehalten werden:

• Einheitliche Nutzung von Marginalspalten – entweder besitzt jede Layoutvariante eine Marginalspalte oder alle Layoutvarianten sind ohne Marginalspalte aufgebaut.

• Identische Reihenfolge der Inhalte – die Abfolge der Inhalte, wie zum Beispiel „Signalwort“ oder „Maßnahmen zur Vermeidung“, muss immer gleich sein.

• Gleiche Spaltenbreite beim Einsatz von Tabellen – die Breite von Tabellenspalten wird im Texteinschub nicht automatisch angepasst. Werden Tabellen zur Gestaltung der Sicherheitshinweise eingesetzt, erfordert dies daher gleiche Spaltenbreiten in allen Layoutvarianten.

• Identische Bezeichnung von Absatz- und Zeichenformaten für die gleichen Textinhalte in allen Layoutvarianten – hilfreich ist es dabei, die Formate nach den zu formatierenden Inhalten zu benennen und die Formate ausschließlich für Absätze in Sicherheitshinweisen einzusetzen, zum Beispiel „Sicherheitshinweis_Signalwort“ oder „Sicherheitshinweis_Maßnahmen“.

• Vermeidung harter Silbentrennung und manueller Zeilenumbrüche, um den Textfluss flexibel zu halten.

• Verwendung einheitlicher Symbole und Grafiken in allen Layoutvarianten – werden die Abbildungen als Rahmen über einem Absatz definiert und dazu auf der Referenzseite abgelegt, können die Symbole dem Layout entsprechend angepasst werden – Abbildung 1.

• Idealerweise sind alle Dokumentationen auf einem einheitlichen Template aufgebaut, und die Varianten entstehen nur durch die unterschiedliche Definition der Formate.

Abb. 1: Ein Texteinschub in zwei Layoutvarianten

Ablage der Sicherheitshinweise

Hat der Technische Redakteur die Bausteine mit den Sicherheitshinweisen erstellt, dann sollte er sie in einem Ordner abspeichern, der den Dokumentationen übergeordnet ist. Wichtig ist, dass Dateien, in denen die Texteinschübe als Referenz eingefügt wurden, in der Ordnerhierarchie nur auf der gleichen Ebene verschoben oder kopiert werden. Nur so bleibt der referenzierte Pfad relativ zum Ursprungsordner gleich.

Es haben sich zwei Konzepte für die Ablage der Bausteine bewährt. Das erste Konzept arbeitet mit einer Datei pro Sicherheitshinweis, der im Haupttextfluss „A“ eingefügt wird. Hierbei wird eine Festlegung für die Dateinamensgebung benötigt, um die Inhalte eindeutig zu kennzeichnen.

Diese Variante hat den Vorteil, dass die Erstellung der Bausteine schnell geht. Die Nachteile sind, dass die genaue Bezeichnung im Datei­namen organisiert werden muss, bei Formatänderungen viele Dateien betroffen sind und zum Vergleich der Inhalte die Fenster nebeneinander angeordnet werden müssen.

Beim zweiten Konzept wird eine Datei, ähnlich einer Bibliothek, mit mehreren Sicherheitshinweisen in verschiedenen Textrahmen und mit unterschiedlich benannten Textflüssen angelegt. Die Hinweise können seitenweise nach Gefährdungsklassen oder Zugehörigkeit zu Produkten gruppiert werden. Die Vorteile sind, dass die Textflussnamen direkt im Dokument verglichen werden können, sich Formatänderungen sofort auf alle Bausteine auswirken und beim Referenzieren immer nur diese eine Datei angesteuert werden muss.

Werden weitere Sicherheitshinweise hinzugefügt, lassen sich die Ergänzungen direkt überblicken und können im Dokument außerhalb der Textrahmen gekennzeichnet werden.

In den nächsten Abschnitten folgt eine Beschreibung der Arbeitsschritte, um nach dem zweiten Konzept eine Sammlung in einem Dokument aufzubauen.

Bibliothek für Sicherheitshinweise

Zunächst müssen zwei Voraussetzungen erfüllt werden:

• Die Datei wird auf Basis eines Templates gestaltet, in dem bereits alle benötigten Formate definiert sind.

• Für die eindeutige und unmissverständliche Bezeichnung der Textflussnamen wurde eine Festlegung getroffen oder auch eine Liste zusammengestellt, in der die Textflussnamen neben die Inhalte der Sicherheitshinweise gestellt werden. Es ist empfehlenswert, die Bezeichnungen durch führende Nummernschlüssel zu ergänzen, weil lange Namen in kurzen Listenfeldern ohne Cursorbewegung nicht vollständig angezeigt werden.

Im ersten Schritt wird ein neues Dokument nach der Vorlage angelegt. Die weitere Gestaltung wird ausschließlich auf den Arbeitsseiten durchgeführt, die dann ein von den Vorgabeseiten abweichendes Layout besitzen. Da diese Datei nicht direkt in eine Technische Dokumentation eingebunden wird, ist der Unterschied kein Nachteil.

Pro Sicherheitshinweis wird ein separater, nicht verknüpfter Textrahmen eingerichtet, in dem der Textfluss einen eindeutigen Namen erhält. Textrahmen können mit Hilfe des Textrahmen-Werkzeugs aus der Grafik-Werkzeugleiste erstellt werden. Einfacher ist es, den im Dokument vorhandenen Textrahmen der Arbeitsseite in der Höhe zu verkürzen. Anschließend kann dieser kopiert und mehrfach eingefügt werden.

Zur Vergabe des Namens wird der Textrahmen als Grafik [Strg] + [Mausklick] markiert und über das Kontextmenü der rechten Maustaste das Dialogfeld „Objekteinstellungen“ ausgewählt – Abbildung 2. Rechts im Gruppenfeld „Textfluss“ wird im Eingabefeld „Typ“ der Name eingetragen.

Anschließend wird der Textrahmen mit dem Sicherheitshinweis gefüllt. Dieser kann aus einem bestehenden Dokument kopiert und fertig gestaltet eingefügt werden, wenn die Formate identisch bezeichnet wurden. Damit beim Importieren des Bausteins in das spätere Dokument keine unnötigen Leerabsätze eingefügt werden, muss das Textfluss-Endezeichen „§“ direkt hinter dem letzten Absatz stehen.

Abb. 2: Textfluss eines Rahmens benennen

Texteinschub wiederverwenden

Beim Bearbeiten einer Anleitung werden zum Einfügen eines Sicherheitshinweises nur noch zwei Arbeitsschritte ausgeführt: Im ersten Schritt wird ein leerer Absatz eingefügt und in diesem Absatz ein umbruchgeschütztes Leerzeichen [Strg] + [Leer] erzeugt. Diesem Absatz wird ein spezielles Format zugewiesen, zum Beispiel „Texteinschub-Anker“, um unerwünschten Nebeneffekten bei Formatänderungen vorzubeugen.

Der Textcursor sollte nun vor das Leerzeichen gestellt werden.

Beim zweiten Schritt wird über das Menü „Datei > Importieren > Datei …“ die Bibliotheksdatei ausgewählt. Wichtig ist, dass im Dialogfeld „Datei“ die Option „Einfügen als Referenz“ ausgewählt ist. Im folgenden Dialogfeld „Textfluss durch Referenz importieren“, Abbildung 3, wird nun in der Liste „Arbeitsseitenfluss“ die gewünschte Bezeichnung gewählt. Die Standardeinstellung „Importierten Textfluss > mit dem Katalog des aktuellen Dokuments neu formatieren“ bewirkt, dass die Layoutdefinitionen der Anleitung angewendet werden. Mit Klick auf die Schaltfläche „Importieren“ wird der Baustein eingefügt.

Der im Dokument folgende Text wird in einen Absatz hinter dem „Texteinschub-Anker“ geschrieben.

Abb. 3: Texteinschub importieren

Fazit

Auch wenn das Separieren von Sicherheitshinweisen Zusatzaufwand bedeutet, wird dieser mehrfach belohnt: Das Einfügen eines Sicherheitshinweises geht schneller von der Hand, es müssen nicht immer wieder Formate zugewiesen werden und die Änderung eines Sicherheitshinweises wirkt sich sofort auf alle Dokumente aus, in denen der Baustein eingefügt wurde.