Standardisierung in Technischer Dokumentation: So helfen Methoden weiter

Ziel jeder Technischen Redaktion ist es, die Technische Dokumentation effizient zu erstellen und zu verwalten. Standardisierungsmethoden helfen dabei, Standards festzulegen: XML-basierte Informationsmodelle, redaktionsspezifische Vorgaben und ein einheitliches Layout. Damit erreichen Sie eine hohe Textqualität. Informationsmodelle und andere praktische Konzepte helfen dabei, Standards bei der täglichen Arbeit einzuhalten. Standards gelten für den Inhalt der Dokumente, den Aufbau sowie für das Layout.

Standardisierung der Inhalte

Konsistenz in Wortwahl und Stil steigert die Textverständlichkeit und damit die Qualität von Handbüchern, Online-Hilfen und dem gesamten Content im Unternehmen. Besonders relevant sind sprachliche Standards für Unternehmen, in denen mehrere Redakteure an der Dokumentation arbeiten. Standardisierungsregeln sind die Voraussetzung dafür, dass einzelne Handbücher oder Module im Redaktionssystem wie aus einem Guss erscheinen. Die stilistischen Eigenheiten der Redakteure verlieren ihre Bedeutung und redaktionsspezifische Vorgaben rücken in den Vordergrund. Diese Regeln halten Sie in einem Redaktionsleitfaden fest.

Ein Lektor kann prüfen, ob die Regeln korrekt umgesetzt sind. Eine automatische Prüfung ist durch professionelle Controlled-Language-Checker-Systeme möglich. In diesen Systemen hinterlegen Sie Terminologie und spezifische Tone-of-Voice-Informationen.

Standardisierung der Struktur – mit Informationsmodell im Redaktionssystem oder ohne

Für die Struktur der Technischen Dokumentation gilt es, einerseits normative und juristische Vorgaben zu beachten und andererseits eine geeignete Struktur auf Bausteinebene zu definieren. Bei XML-Dokumenten gibt es die Besonderheit, dass das jeweilige XML-Informationsmodell schon eine Struktur vorgibt. Zu den bekanntesten standardisierten Informationsmodellen gehören DITA, DocBook und PI-Mod. Die Strukturierungsregeln sind in einer DTD (Document Type Definition) definiert. Diese Informationsmodelle wurden entwickelt, um eine Struktur für gleichartige Produkte festzulegen. Deshalb sieht die DTD für eine Maschine anders aus als die für ein Softwareprodukt.

Von der Kapitelstruktur bis hin auf die Satz- und Wortebene können Elemente festgelegt werden. Ziel ist die Konsistenz der Technischen Dokumentation sowie die Austauschbarkeit und Modularisierung in Redaktionssystemen. Die Umsetzung mit einer XML-Lösung bietet Vorteile. Für Redaktionen ohne Redaktionssystem ist es ebenfalls möglich, diese Strukturen zu erarbeiten und dann konsequent manuell umzusetzen. Schließlich definieren Sie für Ihre Dokumente zum Beispiel nur, welche Art von Inhaltselementen erlaubt sind oder welche Inhaltselemente den vorherigen folgen müssen. So können Sie auch ohne XML-Elemente viele Regeln vorgeben und anwenden.  

Standardisierung des Layouts

Die Corporate Identity ist oft bereits in der Marketing-Abteilung festgelegt und sollte auch für das Layout von Handbuch und Online-Hilfe übernommen werden, um ein einheitliches Bild nach außen zu tragen. Alle anderen Elemente des Layouts, beispielsweise das Aussehen von Sicherheitshinweisen, werden ebenfalls standardisiert. Redakteure nutzen definierte Layout-Vorlagen einheitlich in der kompletten Technischen Dokumentation. Hierbei ist ein XML-basiertes Redaktionssystem hilfreich, aber kein Muss. Regelbasierte Layout-Definitionen lassen sich sowohl mit einfachen DTP-Werkzeugen als auch mit XML- basierten Systemen realisieren, um standardisierte Publikationen zu erzeugen. Ein konsistentes Layout ist im Rahmen von Formatierungsmöglichkeiten, beispielsweise Formatvorlagen und Absatzformate, umsetzbar.

So setzen wir Standards für die Technische Dokumentation um

Wir erstellen Redaktionsleitfäden, erarbeiten Konzepte für Links und Navigation, setzen sinnvolle Modularisierung und erfolgreiche Wiederverwendung von Informationsbausteinen für unsere Kunden um. Wir entwickeln exklusiv auf unsere Kunden zugeschnittene Standardisierungsmethoden. So sind wir erfolgreich damit, durch Single Source Publishing bei der Erstellung der Technischen Dokumentation Redundanzen zu vermeiden.

Wir können Ihnen helfen, sinnvolle Standardisierungen durch bewährte Strukturen und Prozesse zu erarbeiten und Informationsmodelle anzupassen.

Durch diese Standardisierungen erhöht sich die Qualität der Technischen Dokumentation, und die Übersetzungskosten können drastisch reduziert werden.
Redaktionsleitfaden
Link-Konzept
Lektorat
Funktionsdesign-Methode