Info-Portal > Artikel

Regeln, Regeln, Regeln - warum sie sich in der Technischen Doku lohnen

"Nachdem WYSIWYG [What you see is what you get] einmal in der Welt war, man also Texte bis zum Gehtnichtmehr aufhübschen konnte, verbrachte die Menschheit sehr viel Zeit damit, ihre Texte optisch zu optimieren. Bis am Ende mehr Zeit mit der Formatierung als mit der Verfertigung von Texten draufging und die Orientierungslosigkeit groß war in Anbetracht der vielen tollen Gestaltungsmöglichkeiten."
(Bernd Graf im Feuilleton der SZ vom 16./17. April 2016)

Technische Redakteure verbringen auch viel Zeit mit den Texten - aber sie konzentrieren sich dabei auf die Inhalte. Struktur und Layout überlassen sie den einmal nach den Regeln der Corporate Designs festgelegten Templates.

Damit sind einige Vorteile verbunden:

  • Alle Dokumentationen sind sofort mit dem Unternehmen identifizierbar - ein wichtiges Marketing-Instrument.
  • Die Leser wissen, wo sie welche Informationen finden.
  • Die Redakteure beschäftigen sich ausschließlich mit den Inhalten und kommen so schneller zu fertigen Dokumenten.

Was wird geregelt?

Letztlich alles. Einige Bereiche sind auch hinläglich bekannt, z. B. die Regeln des Dudens oder eines ähnlichen Werks, wenn in einer anderen Sprache geschrieben wird, die Regeln der DIN- und EN-Normen oder der Aufbau von Warnhinweisen nach den Vorgaben der ANSI.

Darüber hinaus sind aber weitere Regeln sinnvoll und notwendig, die für jedes Unternehmen passend festgelegt werden. 

Solche Regeln sind im Redaktionshandbuch beschrieben:

  • Definierte Dokumentarten legen fest, an wen sich die Inhalte richten und wie sie ausgegeben werden, z. B. für die Online-Hilfe, als App oder im guten alten Print.
  • Definierte Workflows bilden die verschiedenen Phasen der Dokumentation ab. Von der ersten Recherche, der Strukturierung, der Texterstellung mit definieren Korrekturläufen bis zum Übersetzungsmanagement und der Endkontrolle. 
  • Die Einhaltung des Workflows wird z. B. durch Checklisten dokumentiert, die Teil des Qualitätsmanagements sind.
  • Definierte Verzeichnisstrukturen und Benennungskonventionen – auch für Dateien - vereinfachen die Zusammenarbeit und das Wiederauffinden von Dateien.
  • Eine definierte Terminologie ist zwingend notwendig, wenn mehrere Redakteure für die Technische Dokumentation und für das Marketing arbeiten. Dabei wird neben dem Terminus auch festgelegt, in welchem Umfeld er eingesetzt werden darf. Abbildungen zum Terminus erleichtern den Übersetzern zudem, den korrekten Begriff in der Fremdsprache zu finden.
  • Die Regeln zur Texterstellung legen die Satzmuster fest, in denen die verschiedenen Informationseinheiten geschrieben werden. Dazu gehören z. B. auch die Anzahl der Handlungsschritte in einer Sequenz.
  • Regeln zu Abbildungen und deren Beschriftung legen nicht nur die verwendeten Farben und Legenden fest, sondern auch die Darstellungsart, z. B. Foto oder Strichzeichnung, die Auflösung von Screenshots usw.
  • Das Layout für Texte legt z. B. den Textrahmen, Absatz und Zeichenformate fest ­ und verbietet jeden manuellen Eingriff. Alle Ausnahmen müssen definiert sein, z. B. manuelle Seitenumbrüche, Anpassungen von Tabellen usw.
  • Was für die Texte gilt, gilt auch für die Online-Ausgaben. Oberstes Prinzip ist die Wiedererkennbarkeit und damit die Identifikation mit dem Unternehmen. Alle Apps, alle Online-Hilfen müssen dazu nach festen Vorgaben gestaltet sein.

Wie entwirft man solche Regeln?

Wie schon gesagt: Die Regeln müssen im Unternehmen festgelegt werden ­ und zwar mit allen Beteiligten. Wer nicht mit entscheiden durfte, wird sich immer schwertun mit den Regeln der "Anderen".

Hilfestellungen bei der Definition von Regeln bieten nicht nur die Vorgaben bestimmter Verfahren, z. B. DITA als Grundlage für eigene Strukturdefinitionen. Zahlreiche Publikationen beschäftigen sich mit Einzelaspekten, z. B. mit der Typografie, mit der Verwendung von Farben und Abbildungen. Für die Erstellung von Textregeln gibt es eine Publikation der tekom, in der sich zahlreiche Beispiele und Alternativen finden.

WARNUNG: Regeln zu entwickeln ist kein kurzer schneller Prozess. Je mehr Beteiligte, desto länger kann es dauern, bis ein Regelwerk so weit entwickelt ist, dass es angewendet werden kann. Und es muss "leben". Das bedeutet, dass die Regeln immer mal wieder mit dem "Alltag", mit veränderten Anforderungen der Zielgruppen abgeglichen und angepasst werden müssen. Und doch: Was Sie an Zeit (und Geld) in das Regelwerk investieren, macht sich bezahlt, wenn Sie merken, wie die Produktion der Technischen Dokumentation beschleunigt wird und wie einfach sie den schnellen Modellwechseln von Produkten gewachsen ist. 

  • Frau liest Ordner

Aktuelle Artikel

Info-Portal

Info-Portal

  • Frau mit Reagenzglas

Info-Portal