tekom Leitlinie: Regelbasiertes Schreiben Deutsch für die Technische Kommunikation

Transkript

1 LG Sachsen, Dresden, 28. November 2011 tekom Leitlinie: Regelbasiertes Schreiben Deutsch für die Technische Kommunikation Dr. Michael Fritz, Geschäftsführer tekom Dr. Meike Wiehl, Gremien/Internationale Kontakte tekom

2 Wozu diese Leitlinie? Richtungsweisende Arbeitsunterlage für Fachleute Entscheidungshilfe für die Erstellung eines unternehmensspezifischen Regelwerks Ziele: Qualität der produzierten Texte sicherstellen Wirtschaftlichkeit bei der Texterstellung erhöhen Übersetzungskosten senken

3 Struktur der Leitlinie Didaktisch-methodische Einleitung Schreib- und Formulierungsregeln: ca. 100 Regeln Kap. 3-5: Text, Satz, Wort Zugangshilfen und Glossar Index Basisregeln Regelmatrix Informationsarten Glossar

4 Veranlassung Konsistente Texte Verständlichkeit Wiederverwendbarkeit Übersetzungsgerechtes Schreiben Überprüfbarkeit der Qualität Zielgruppe Arbeiten mit der Leitlinie Redaktionsverantwortliche Sprachtechnologen

5 Arbeiten mit der Leitlinie Reichweite der Regeln Formulierungen Redaktionsleitfaden, Corporate Wording Regel-Alternativen Für manche Fragestellungen gibt es mehrere korrekte Regelvorschläge. Alternativ-Regeln besitzen dieselbe Nummer, die pro Alternative um einen Buchstaben ergänzt ist (z. B. 115a, 115b). Mitgeltende Regelwerke Z. B. DIN EN DUDEN

6 Textregeln - Regeln für sprachliche Elemente zur Orientierung des Lesers: Aufbau von Überschriften Stilistische Regeln für Überschriften Index und Verweise Satzregeln - Regeln, die für die Formulierung von Sätzen gelten: Vermeidung von mehrdeutigen Konstruktionen Vermeidung von unvollständigen Konstruktionen Vermeidung von komplexen Strukturen Regeln zur Wortstellung und Abfolge von Satzelementen Stilistische Regeln Gliederung der Regeln 1/2

7 Gliederung der Regeln 2/2 Wortregeln - Regeln, die für einzelne Wörter gelten: Bindestriche in Komposita Zahlen in Komposita Sonderzeichen in Komposita Großbuchstaben innerhalb eines Wortes Genitivbildung Dativbildung Umgang mit Abkürzungen

8 Beschreibungsmodell Regelnummer und Regelüberschrift Regel (kurzer Satz mit direkter Anrede) Handlungsanweisung Negativ- und Positivbeispiele (Tabelle) Entscheidungshilfe Maschinelle Prüfbarkeit

9 Regelmatrix Informationsarten 6 Informationsarten Wartungsanleitung, Funktionsbeschreibung, Technische Daten, Warnhinweis, Sicherheitshinweis, Störungsbehebung, Advance Organizer (steht am Anfang eines Textes und liefert Überblick über den folgenden Inhalt) Teilweise mit Unterklassen In Bezug zu allen Regeln 5-wertige Skala Von stets gut geeignet bis nicht relevant Pro Regel eine allgemeingültige Einstufung allgemein verwendbar Vermeidensregel

10 Basisregeln Hilfestellung für Anfänger, Laien und Quereinsteiger Empfehlung als Einstieg in das Thema sprachliche Qualitätssicherung Auswahl durch AG-Mitglieder unter Berücksichtigung der Beta-Test-Ergebnisse

11 Beispiel 1 für eine Textregel Regel T 102: In Überschriften keine Nebensätze verwenden Regel: Verzichten Sie in Überschriften auf Nebensatz-Konstruktionen. Negativbeispiel: Reinigungsmittel, die zu verwenden sind Positivbeispiel: Zulässige Reinigungsmittel Entscheidungshilfe: Aufgrund der syntaktischen Komplexität sind Nebensatzkonstruktionen für Überschriften grundsätzlich nicht geeignet. Maschinelle Prüfbarkeit: Möglich. Voraussetzung: Überschrift ist durch entsprechendes Tagging gekennzeichnet.

12 Beispiel 2 für eine Textregel Regel T 202: Indexeinträge redundanzfrei formulieren Regel: Halten Sie Indexeinträge frei von inhaltlichen Redundanzen. Negativbeispiel: MIF-Dateiformat - Dateien importieren, - Dateien öffnen, - Dateien speichern Positivbeispiel: MIF-Datei - importieren, - öffnen, -speichern Entscheidungshilfe: Inhaltlich klar fokussierte Indexeinträge halten den Index übersichtlich und sorgen dafür, dass Leser schnell die gewünschten Stichworte finden. Maschinelle Prüfbarkeit: Nicht geeignet

13 Beispiel 3 für eine Textregel Regel T 204: Wortgruppen in Haupteinträgen vermeiden Regel: Verwenden Sie für Haupteinträge möglichst nur ein Wort. Vermeiden Sie komplexe Wortgruppen. Negativbeispiel: nicht verankerte Grafikrahmen auflösen Positivbeispiel: Grafikrahmen auflösen Entscheidungshilfe: Je einfacher die syntaktische Konstruktion eines Haupteintrags, desto einfacher finden sich die Leser im Index zurecht. Komplexe Einträge erschweren das Lesen und Verstehen. Maschinelle Prüfbarkeit: Möglich

14 Beispiel 4 für eine Textregel Regel T 301: Implizite Verweise vermeiden Regel: Verweisen Sie immer direkt und eindeutig auf andere Textstellen oder andere Texte. Geben Sie ein eindeutiges Verweisziel an. Negativbeispiel: Wird an anderer Stelle näher beschrieben. Positivbeispiel: Siehe Kapitel Montage auf Seite 123. Entscheidungshilfe: Direkte Verweise helfen dem Leser bei der Orientierung im Text und der schnellen Lösung von Problemen. Indirekte Verweise stellen den Leser vor das zusätzliche Problem, Textstellen suchen zu müssen. Maschinelle Prüfbarkeit: Nicht geeignet

15 Beispiel 5 für eine Textregel Regel T 302: Ausreichende Informationen zum Verweisziel Regel: Geben Sie immer ausreichende Informationen zum Verweisziel und der Art des Verweises an. Negativbeispiel: Montieren Sie das Gerät in einer Unterputzdose (s. S. 99). Positivbeispiel: Montieren Sie das Gerät in einer Unterputzdose (Liste geeigneter Unterputzdosen siehe S. 99). Entscheidungshilfe: Wenn der Leser einem Verweis folgt, muss er den Textfluss verlassen. Dabei muss er abwägen können, ob es sich für die Lösung seiner Problemstellung lohnt, dem Verweis zu folgen. Maschinelle Prüfbarkeit: Nicht geeignet

16 Beispiel 6 für eine Textregel Regel T 503: Im Glossar erklärte Fachwörter im Anleitungstext kennzeichnen Regel: Kennzeichnen Sie im Anleitungstext deutlich die Wörter, die im Glossar erklärt werden. Negativbeispiel: Wählen Sie ein Ausgabeformat. Positivbeispiel: Wählen Sie ein Ausgabeformat. Entscheidungshilfe: Durch die Kennzeichnung erkennt der Leser, welche Fachwörter er bei Bedarf im Glossar nachschlagen kann. Maschinelle Prüfbarkeit: Nicht geeignet

17 Beispiel 1 für eine Satzregel Regel S 202: keine Sätze ohne Verb formulieren Regel: Vermeiden Sie Satzkonstruktionen ohne Verb. Handlungsanweisung: Schreiben Sie den Satz vollständig mit einem Verb. Negativbeispiel: Kühler defekt? Positivbeispiel: Prüfen Sie, ob der Kühler defekt ist. Entscheidungshilfe: Wenn Sätze Verben enthalten, werden Mehrdeutigkeiten vermieden und Leser können die Informationsarten schneller erfassen. Zusätzlich wird die Übersetzung erleichtert, da Verben grammatikalische Bezüge zeigen. Maschinelle Prüfbarkeit: Verfügbar

18 Beispiel 2 für eine Satzregel Regel S 204: Keine Wortteile weglassen Regel: Lassen Sie keine Wortteile weg. Handlungsanweisung: Verwenden sie die Wörter vollständig. Negativbeispiel: Das Gerät zunächst auf- und nach Einlegen der Batterie wieder zuschrauben. Positivbeispiel: Das Gerät aufschrauben. Die Batterie einlegen. Das Gerät zuschrauben. Entscheidungshilfe: Das Verständnis kann erschwert sein. Eine solche Konstruktion ist insbesondere für die Übersetzung in Fremdsprachen ungünstig. Maschinelle Prüfbarkeit: Verfügbar

19 Beispiel 3 für eine Satzregel Regel S 305: Weit auseinanderstehende Verbteile vermeiden Regel: Vermeiden Sie auseinanderstehende Verbteile/Satzklammern. Handlungsanweisung: Formulieren Sie einen Satz so, dass die Verbteile nah beieinander stehen. Negativbeispiel: Sie fügen die Objekte, die Sie für die Darstellung des Prozesses benötigen, in Ihr Bild ein. Positivbeispiel: Sie fügen die Objekte in Ihr Bild ein, die Sie für die Darstellung des Prozesses benötigen. Entscheidungshilfe: Weit auseinanderstehende Verbteile erschweren die Textverständlichkeit, da sie das Kurzzeitgedächtnis beanspruchen. Der Leser erkennt erst am Ende des Satzes den Zusammenhang. Maschinelle Prüfbarkeit: Verfügbar

20 Beispiel 4 für eine Satzregel Regel S 308: es als Platzhalter nicht verwenden Regel: Wenn es als Platzhalter für einen nachfolgenden Nebensatz oder für das Subjekt steht, formulieren Sie den Satz ohne es. Handlungsanweisung: Stellen Sie den Satz so um, dass der Nebensatz oder das Subjekt an erster Stelle stehen oder formulieren Sie den Nebensatz in einen Hauptsatz um, sodass es entfallen kann. Negativbeispiel: Es sind weitere Maßnahmen erforderlich. Positivbeispiel: Weitere Maßnahmen sind erforderlich. Entscheidungshilfe: Solche Konstruktionen erschweren die Informationsentnahme, da sie den Satzbau unnötig komplex machen. Maschinelle Prüfbarkeit: Verfügbar

21 Beispiel 5 für eine Satzregel Regel S 314: Keine doppelten Verneinung verwenden Regel: Verwenden Sie keine doppelte Verneinung. Handlungsanweisung: Formulieren Sie den Sachverhalt direkt und positiv. Negativbeispiel: Stellen Sie sicher, dass nicht zugelassene Geräte nicht in Betrieb gesetzt werden. Positivbeispiel: Stellen Sie sicher, dass nur zugelassene Geräte in Betrieb gesetzt werden. Entscheidungshilfe: Doppelte Verneinungen sind oft überflüssig und schwer verständlich. Maschinelle Prüfbarkeit: Verfügbar

22 Beispiel 6 für eine Satzregel Regel S 502: Passiv mit Täterangabe vermeiden Regel: Vermeiden Sie eine Passivkonstruktion, wenn der Handelnde im Satz genannt wird. Handlungsanweisung: Formulieren Sie den Satz im Aktiv. Negativbeispiel: Das defekte Teil wird von einem Service-Mitarbeiter ausgetauscht. Positivbeispiel: Ein Service-Mitarbeiter tauscht das defekte Teil aus. Entscheidungshilfe: Passiv ist dann sinnvoll, wenn der Handelnde nicht bekannt ist oder nicht genannt werden soll. Wenn der Agens einer Handlung genannt wird (= der Handelnde), ist eine Formulierung im Aktiv die bessere Wahl. Maschinelle Prüfbarkeit: Verfügbar

23 Beispiel 1 für eine Wortregel Regel B 101: Komposita aus zwei Basismorphemen immer ohne Bindestrich Regel: Schreiben Sie Komposita aus zwei Basismorphemen immer ohne Bindestrich. Negativbeispiel: Auswahl-Maske, Ablass-Hahn Positivbeispiel: Auswahlmaske, Ablasshahn Entscheidungshilfe: Komposita aus zwei Basismorphemen sind so übersichtlich, dass auch ohne Bindestriche keine Verständnisprobleme auftreten. Maschinelle Prüfbarkeit: Verfügbar

24 Beispiel 2 für eine Wortregel Regel B 102a: Komposita aus drei Basismorphemen immer mit Bindestrich Regel: Schreiben Sie Komposita aus drei Basismorphemen immer mit Bindestrich. Negativbeispiel: Betriebsstundenzähler, Arbeitsschutzkleidung Positivbeispiel: Betriebsstunden-Zähler, Arbeitsschutz-Kleidung Entscheidungshilfe: Diese Schreibweise erhöht die Lesbarkeit und vermeidet Fehlinterpretationen. Verwenden Sie diese Regel, wenn Ihr Text unter schwierigen Bedingungen gelesen wird (schlechte Beleuchtung, Lesern mit unterschiedlichem Bildungsstand). Maschinelle Prüfbarkeit: Verfügbar

25 Beispiel 3 für eine Wortregel Regel B 102b: Komposita aus drei Basismorphemen immer ohne Bindestrich Regel: Schreiben Sie Komposita aus drei Basismorphemen immer ohne Bindestrich. Negativbeispiel: Betriebsstunden-Zähler, Arbeitsschutz-Kleidung Positivbeispiel: Betriebsstundenzähler, Arbeitsschutzkleidung Entscheidungshilfe: Bei drei Basismorphemen ist das Kompositum noch so gut lesbar, dass es nicht notwendig ist, es aufzuspalten. Maschinelle Prüfbarkeit: Verfügbar

26 Beispiel 4 für eine Wortregel Regel B 104: Komposita mit Abkürzungen immer mit Bindestrich Regel: Schreiben Sie Komposita, die Abkürzungen enthalten, immer mit Bindestrich. Negativbeispiel: Telefon Nr., Telefonnr. Positivbeispiel: Telefon-Nr. Maschinelle Prüfbarkeit: Verfügbar

27 Beispiel 5 für eine Wortregel Regel B 119: Schrägstrich in Benennungen vermeiden Regel: Vermeiden Sie Schrägstriche als Ersatz für und, oder oder bzw. bei der Neubildung von Benennungen. Handlungsanweisung: Entscheiden Sie sich, ob eine Und- oder eine Oderverknüpfung vorliegt. Bilden Sie eine entsprechende zusammengesetzte Benennung. Negativbeispiel: Ein-/Ausgangssignale Positivbeispiel: Ein- und Ausgangssignale Entscheidungshilfe: Sonderzeichen erschweren die (maschinelle) Übersetzung von Texten und können die Verständlichkeit einschränken. Maschinelle Prüfbarkeit: Verfügbar

28 Beispiel 6 für eine Wortregel Regel B 122: Großbuchstaben innerhalb eines Wortes vermeiden Regel: Verwenden Sie keine Großbuchstaben innerhalb von Wörtern. Negativbeispiel: Physikalisch-Technisches Verständnis, GrafikDisplay Positivbeispiel: physikalisch-technisches Verständnis, Grafikdisplay Entscheidungshilfe: Diese Regel gilt auch für Komposita mit Bindestrichen. Ausgenommen von dieser Regel sind Eigennamen, Produkt- und Firmenbezeichnungen. Maschinelle Prüfbarkeit: Verfügbar

29 Beispiel 7 für eine Wortregel Regel B 201: Abkürzungen ohne Zahlwert ausschreiben Regel: Wenn Abkürzungen wie ca., max. oder min. ohne Zahlwert auftreten, schreiben Sie diese Abkürzungen aus. Negativbeispiel: Die Abweichung bestimmt die max. zulässige Höhe von Buchungsbeträgen. Positivbeispiel: Die Abweichung bestimmt die maximal zulässige Höhe von Buchungsbeträgen. Maschinelle Prüfbarkeit: Verfügbar

30 Beispiel 8 für eine Wortregel Regel B 202: Etablierte Abkürzungen nicht ausschreiben Regel: Schreiben Sie folgende Wendungen aus der Allgemeinsprache im Fließtext nicht aus: zum Beispiel, das heißt, unter anderem, und so weiter, gegebenenfalls. Handlungsanweisung: Verwenden Sie die etablierten, lexikalisierten Abkürzungen. Eine etablierte Abkürzung erkennen Sie daran, dass sie in einschlägigen Wörterbüchern (Duden, Wahrig) aufgeführt wird. Negativbeispiel: Dazu gehören unter anderem Muttern und Schrauben. Positivbeispiel: Dazu gehören u.a. Muttern und Schrauben. Maschinelle Prüfbarkeit: Verfügbar

31 Das Projekt tekom-arbeitsgruppe mit 16 Mitgliedern aus den Bereichen Industrie, Hochschule, Dienstleistungsunternehmen und Tool-Hersteller Beta-Version von 39 tekom-mitgliedern getestet Arbeitsmittel: Web- und Telefonkonferenzen und Wiki Projektdauer: 18 Monate

32 Autoren der Leitlinie Birgit Bellem, Wurm Elektronische Systeme GmbH, Remscheid Dipl.-Germ. Johannes Dreikorn, doctima GmbH, Erlangen Prof. Dr. Petra Drewer, Hochschule Karlsruhe Technik und Wirtschaft Isabelle Fleury M.A., Fleury & Fleury GbR, Erkrath Ralf Haldimann M.A., Busch-Jaeger Elektro GmbH, Lüdenscheid Martin Jung, cognitas. Gesellschaft für Technik-Dokumentation mbh, Ottobrunn Udo P. Keul M.Sc., Endress+Hauser GmbH+Co. KG, Maulburg Dr. Viktoria Klemm, BAUR Prüf- und Messtechnik GmbH, Sulz, Österreich Dipl.-Fachübers. Sabine Lobach, Hochschule Karlsruhe Technik, und Wirtschaft Ines Prusseit, acrolinx GmbH, Berlin Dipl.-Übers. Ursula Reuther, IAI Institut der Gesellschaft, zur Förderung der Angewandten Informationsforschung e. V., Saarbrücken Dipl.-Phys. Roland Schmeling, Schmeling + Consultants GmbH, Heidelberg Prof. Dr. Klaus-Dirk Schmitz, Fachhochschule Köln Dipl.-Ing. Volker Sütterlin, Siemens AG, Karlsruhe.

33 Publikation ISBN Seiten Print-Ausgabe: für tekom-mitglieder 55, sonst 65 PDF-Ausgabe: für tekom-mitglieder 35, sonst 55 Bestellung: Fax-Formular unter /Publikationen im Artikel Regelbasiertes Schreiben

34 Vielen Dank für Ihre Aufmerksamkeit Weitere Informationen: Gesellschaft für Technische Kommunikation e. V. - tekom Rotebühlstraße Stuttgart Phone: +49 (0)711/ Fax: +49 (0)711/ Webseite: info@tekom.de