Technik-Dokumentation: Was nutzen öffentlich zugängliche Styleguides?
In sogenannten Styleguides werden die Gestaltungsrichtlinien zusammengefasst. Im Bereich der Technik-Dokumentation ist damit die einheitliche Gestaltung von Dokumenten gemeint. Das beinhaltet die Strukturierung, das Aussehen (Design), die Typografie, Schriftarten, Farben und weitere Elemente. Sehr wesentlich ist es, Formatvorgaben festzulegen, die die Elemente einer Anleitung eindeutig erkennbar machen, z.B. Formate für die Gestaltung von Handlungsschritten, Warnhinweisen oder Folgen einer Handlung. Ein Styleguide ist ein wichtiges Element in einem Redaktionshandbuch.
Dieser Artikel beschränkt sich auf folgende Themenbereiche:
- Rechtschreibung
- Kontrolle der verwendeten Terminologie
- Grammatikunterstützung
- Kontrolle des Satzbaus (z.B. Satzlängen, Aktiv, Passiv, und eher neu weitergehend: dialogorientiert ja/nein, Lebendigkeit)
Neben Regeln für den Schreibstil enthalten Redaktionsleitfäden oft auch Informationen über:
- Verwendung von Bildern und die Bildgestaltung
- Abgrenzung verschiedener Dokumentarten
- Verfahrensanweisungen zur Dokumentationserstellung und Ablage
Jeder Technik-Autor benötigt einen Styleguide oder Redaktionsleitfaden
Von der kontrollierten Sprache zum Tone of voice
Die Technik-Dokumentation unterliegt in besonderem Maß der sogenannten „kontrollierten Sprache”. Die Sprache von guter Technik-Dokumentation kennt keinen Wechsel von Sequenzmustern zur Erhöhung der Lesespannung, kein Spiel mit der Sprachrhythmik zum „farbigeren” Lesen, kein Variieren von Begriffen durch Verwendung vieler Adjektive usw.
So ganz anders sind Marketingtexte formuliert, eine emotionale Bindung zum Leser soll bewusst aufgebaut werden. Es wird mit der Sprache bewusst gespielt, um Überraschungseffekte zu erzeugen und Aufmerksamkeit zu wecken. Neueste Ansätze versuchen, einen Bogen zwischen klassischer Technik-Dokumentation und Marketingtexten zu spannen, Stichwort: Content-Marketing.
Positive Firmensprache
Unter dem Aspekt „Tone of voice” werden Stilmittel thematisiert, die Fakten mit Emotion verbinden wollen: „Fakten sagen der analytischen Seite des Gehirns, was das Unternehmen tut, während der Ton der kreativen Seite des Gehirns sagt, wie es mit den Fakten umgehen soll.” (aus einer Information von Acrolinx, eines der führenden Systeme für Autorenunterstützung). Die meisten Styleguides, die hier vorgestellt werden, öffnen sich diesem neuen Blick ein wenig, indem sie den „Tone of voice” – auch als „Brand voice” bekannt, also den Aspekt einer speziellen positiven Firmensprache – betrachten.
Ob man diesen neuen Stil auch verstärkt den klassischen Anleitungen zuordnen sollte, muss man bei der Verabschiedung eines firmenindividuellen Styleguides führen. Vielleicht entsteht auch ein neuer eigenständiger Dokumenttyp zusätzlich zu den klassischen Anleitungen, die etwa Beispiele der Produktanwendung auch emotional ansprechend thematisieren.
Kontrollierte Sprache statt Schuldeutsch
Es ist offensichtlich, dass ein zweckgerichteter, regelbasierter Schreibstil nicht übereinstimmt mit dem, was man gern als „Schuldeutsch” bezeichnet. Umso mehr benötigt ein Technik-Autor klare Hilfestellungen, die es ihm erleichtern, kontrollierte Sprache zu verwenden. Deshalb werden Systeme zur sogenannten „Autorenunterstützung”, quasi elektronische Styleguides, immer beliebter.
Dennoch sollte jede Technik-Redaktion die Idee hinter dem System, eben die Regeln selbst, bewusst reflektieren: Ein Styleguide als Lehr- oder Nachschlagewerkzeug, als „lebendiges” Werk, das sich neuen Anforderungen ständig anpasst, macht durchaus Sinn.
Styleguides zu erstellen, kann durchaus eine herausfordernde Aufgabe darstellen. So müssen zum Beispiel die Variationsmöglichkeiten, die gemäß der neuen deutschen Rechtschreibung eingeführt wurden, nun in strikte Firmenregeln ohne Variation umgewandelt werden.
Dieser Artikel will helfen, die Aufgabe der Styleguide-Erstellung und -Pflege zu erleichtern, indem er öffentlich zugängliche Styleguides vorstellt, neue Styleguide-Trends präsentiert und einige wichtige Regeln komprimiert darstellt.
Der Blick ins Web
Interessant ist, dass alle wichtigen und frei zugänglichen Styleguides lediglich die englische Sprache abdecken. Das liegt sicher daran, dass die bekanntesten Firmen, vor allem im Bereich Software, amerikanische Firmen sind, wie z.B. Apple, Google, IBM und Microsoft.
Aber im weiteren Sinn liegt das auch daran, dass Englisch die eine Weltsprache darstellt und alle anderen Sprachen nur noch als zu übersetzende Zielsprache genutzt werden, selbst in deutschen Firmen. So liefert SAP als ursprünglich deutsche Software-Schmiede die meisten Informationen auf Englisch, wie etwa den SAP Writing Style Quick Guide.
Für Hardware, insbesondere den Maschinenbau, ist nur die Spezifikation ASD-STE100 (Simplified Technical English) als kostenloses Regelwerk bekannt. Für die deutsche Sprache ist der tekom-Leitfaden sehr zu empfehlen: Regelbasiertes Schreiben – Deutsch für Technische Kommunikation, 2. Auflage. DIN A4, 168 Seiten, broschiert, 2., erweiterte Auflage 2013, ISBN 978-3-9814055-9-0 (Softcover & E-Book-PDF, 142,50 €, für Mitglieder 92,50 €).
Rechtschreibung
Wenn es „nur” um die deutsche Rechtschreibung geht, deckt Duden-Online (www.duden.de/woerterbuch) kostenlos alle wichtigen Aspekte ab.
Firmen-Styleguide soll Variantenvielfalt beseitigen
Die wichtigste Aufgabe für einen Firmenstyle-Guide in Bezug auf Rechtschreibung ist, die eingeführten erlaubten Varianten bei der Rechtschreibung zu beseitigen. Die Referenz auf den Duden allein genügt nicht. Das aktuelle amtliche Regelwerk (letzte Aktualisierung August 2020) erstellt übrigens der Rat für deutsche Rechtschreibung (www.rechtschreibrat.com/regeln-und-woerterverzeichnis).
Leider ist es offenbar nicht die Aufgabe des Rats, die Informationen ergonomisch effizient zur Verfügung zu stellen. Allerdings wurde mit grammis (https://grammis.ids-mannheim.de/rechtschreibung) ein wissenschaftliches Informationssystem zur deutschen Grammatik entwickelt, in dem die amtlichen Regeln zur Rechtschreibung online abrufbar sind:
Wichtige Bereiche der deutschen Rechtschreibprüfung
Die drei wichtigsten zu treffenden Entscheidungen bei der Rechtschreibung sind mit Blick auf einen Firmen-Styleguide:
- Getrennt- und Zusammenschreibung. Beispiele: „staubsaugen / Staub saugen; instand setzen / in Stand setzen; offenstehende Tür / offen stehende Tür”
- Schreibung mit Bindestrich. Beispiele: 7-Bit-Code, Stand-by-System, H2O-gesättigt, aber: 100%ig
- Groß-/Kleinschreibung. Beispiele: Ad-hoc-Entscheidung, pH-Wert-Bestimmung, zehntel Millimeter/Zehntelmillimeter
Die Beispiele lassen erahnen, wie schwierig entweder Regeln zu formulieren sind oder eine bestimmte Variante als einzig erlaubte im Firmen-Styleguide festgelegt werden kann. Neben der eindeutigen Festlegung von Terminologie (Fachausdrücke) ist künftig auch eine Wortliste allgemeinsprachlicher Wörter mit festgelegter Schreibvariante unumgänglich. Beides ist wohl nur in einer dedizierten Terminologie-Datenbank effizient zu verwalten.
