Roadmap: Redaktionsleitfaden für eine technische Dokumentation 4.0

Nach den sehr gelungenen Zimtsternen haben Thomas G. und Markus F. beschlossen, dass ein Redaktionsleitfaden zu einer gut geschriebenen technischen Dokumentation führt.

Regeln sind alles!

Markus F. schlägt vor, sich erst einmal auf grammatikalische und stilistische Regeln für einen Redaktionsleitfaden zu konzentrieren. Nach langem Suchen findet er die Leitlinie „Regelbasiertes Schreiben“ der TEKOM und die Regeln von Simplified Technical English. Er erwirbt beide Ausgaben und liest sich ein.

Simplified Technical English

Im Falle von Simplified Technical English gibt es ein Grundwörterbuch mit erlaubten und verbotenen Wörtern. Außerdem gibt es klare Schreibregeln zu:

  • Grammatik
  • Aufbau
  • Länge

Technische Fachbegriffe werden in verschiedene Kategorien gepackt. „Terminologie sozusagen!“, freut sich Markus F.

Er nimmt sich einen übersetzten Text und versucht diesen umzuschreiben. Er braucht ziemlich viel Zeit, aber der Vorher – Nachher-Effekt ist deutlich zu erkennen:

Vorher:

Nachher:

Making Pizza

How to make pizza

First of all, preheat the oven to 400° Fahrenheit (204°Celsius): the oven should be piping hot before you start cooking the pizza.

Make pizza as follows:

1. Set the oven temperature to 400° Fahrenheit (204°Celsius).

2. Wait until the oven has a temperature of 400° Fahrenheit (204°Celsius).

In order to prepare the crust, first remove the unbaked crust from the packaging, then place it on a round or rectangular baking sheet, depending on what you have on hand. Use a pastry brush to spread a thin coating of olive oil over the top of the crust.

3. Prepare a circular or a rectangular baking sheet.

4. Open the packing of the unbaked crust.

5. Remove the unbaked crust from the packing.

6. Put the unbaked crust on the baking sheet.

7. Apply a thin layer of olive oil with a pastry brush on the crust.

 

Now you can spread pizza sauce on the crust. How much pizza sauce you add is purely a matter of personal preference: if you love a lot of sauce, go ahead and slather it on. On the other hand, if you prefer your pizza on the dry side, spoon a little in the middle and spread it around in a thin layer. But if you want to make a white pizza, add just a little extra olive oil and skip the pizza sauce.

8. Put a pan on the stove.

9. Open a can of diced tomatoes.

10. Put the diced tomatoes in the pan. Do not drain them.

11. Put tomato paste in the pan.

12. Add salt, oregano and pepper.

13. Set the stove to ON.

14. Boil the tomato sauce until it has the necessary consistency.

15. Set the stove to OFF.

16. Put the tomato sauce on the unbaked crust with a spoon.

 

For a dry pizza, apply a thin layer of tomato sauce only.

 

For a white pizza, do not put the tomato sauce on the pizza. Put more olive oil on the unbaked crust.

 

 

“Du denkst ja nur ans Essen!”, lacht Sabrina L. Aber was nützt dir denn das Englische für deinen Redaktionsleitfaden? Wir schreiben unsere Anleitungen auf Deutsch.

„Ich kann die Regeln doch ins Deutsche übertragen!“, denkt Markus F. und macht sich ans Werk.

Redaktionsleitfaden

Imperativ

Wenn der Bediener etwas tun muss, muss der technische Redakteur die Befehlsform verwenden. Dann ist dem Bediener klar, dass er ans Werk muss.

Also bei Vorgehensweisen:

  • Nummerierte Liste verwenden
  • Imperativ verwenden
  • Einleitenden Satz vor der nummerierten Liste verwenden
  • Ergebnis nach Abschluss der nummerierten Liste erklären.

Sabrina L lacht: „Das ist ja wie ein Sandwich. Und schon wieder sind wir beim Essen. Schau mal! Ich habe ein Beispiel gefunden.“

Titel

Die Titel müssen kurz, erklärend und einheitlich strukturiert sein.

Verbale Titel sind gut verständlich.

Beispiel.

Schlecht

Gut

Installation eines Drivers

Driver installieren

Wie ich den PC einrichte

PC einrichten

In der Leitlinie der TEKOM gibt es verschiedene Ansätze. Wichtig ist es, sich für eine Methode zu entscheiden und diese durchweg anzuwenden.

Titel und Untertitel

Unnötige Wiederholungen müssen in der Titelstruktur weggelassen werden. Ansonsten sind die Titel nicht leserfreundlich und die Gliederung ist nicht immer klar.

Schlecht

Gut

1. Maschinenbetrieb

1 Maschine bedienen

1.1. Maschinenbetriebsparameter

1.1. Parameter einstellen

1.2. Betrieb der Maschine vorbereiten

1.2 Maschine vorbereiten

Gut strukturierte und organisierte Titel dienen dem Bediener zur Orientierung in der Anleitung. Das darf man nie aus dem Auge verlieren. Die Titel sind die Grundstruktur eines Dokuments.

Pronomen

Im Gegensatz zu Büchern sollte man in der technischen Redaktion keine Pronomen verwenden. Denn Pronomen können zu Missverständnissen führen.

Schlecht

Gut

Der Mann geht mit dem Hund spazieren. Er ist alt.

FRAGE:

Wer ist alt? Der Mann oder der Hund?

Der Mann geht mit dem Hund spazieren. Der Mann ist alt.

Nun ist klar, dass es sich um den Mann handelt.

Präpositionen

Oftmals lassen technische Redakteure Präpositionen weg. Dann geht das Schreiben schneller und man spart Platz. Aber oftmals fehlen dem Leser dann die Bezüge. Das kann irreführend werden.

Schlecht

Gut

Öl Bremse Rad

FRAGE:

Ist das Öl für das Rad oder für die Bremse?

Öl für Radbremse

Nun ist klar, wofür das Öl verwendet wird. Außerdem hilft das zusammengesetzte Nomen beim Verständnis.

Passiv

Passiv-Sätze lassen den Zweifel, wer etwas machen muss. In der technischen Redaktion sind Passivsätze zu vermeiden. Der Bediener muss wissen, was er tun muss. Interpretationsmöglichkeiten müssen ausgeschlossen werden!

Schlecht

Gut

Die Maschine muss ausgeschaltet werden.

FRAGE:

Wer schaltet die Maschine aus?

Die Maschine ausschalten.

Der Imperativ weist den Leser darauf hin, die Maschine auszuschalten.

Schreibstil

„Wir haben ja schon von nummerierten Listen geredet. Das ist eigentlich keine Grammatik.“, stellt Markus F. fest. „Sabrina, lass uns doch auch mal die Struktur und den Schreibstil analysieren.“

Kurze Sätze

Schachtelsätze sind meist unverständlich. Der Leser muss mehrmals den Satz lesen. Besonders in einem beschreibenden Text sollte man auf die Textlänge achten. Als Daumenregel könnte man maximal 20-25 Wörter festlegen.

Schlecht

Gut

Die Maschine ist eine Druckmaschine, die von nur sehr gut ausgebildeten Personen, die eine Ausbildung in diesem Bereich mit mindestens 5 Jahren Erfahrung an der Maschine, bedient werden darf, um zu verhindern, dass die Produktion fehlerhaft oder komplett zu entsorgen ist.

Die Druckmaschine darf nur von ausgebildetem Fachpersonal mit 5 Jahren Berufserfahrung bedient werden. Das verhindert Fehler bei der Produktion sowie einen Produktionsstopp.

Der Aufbau und die Sequenz der Sätze müssen logisch sein und dem Ablauf der Vorgänge entsprechen.

Listen

Sowohl nummerierte als auch Punktlisten müssen einheitlich sein:

  • Die Groß- und Kleinschreibung muss definiert sein.
  • Die Zeichensetzung muss definiert sein.
  • Sätze dürfen nicht unterbrochen werden.

Schlecht

Gut

Der Bediener muss:

–          die Maschine

–          Den Strom,

–          Das Licht

ausschalten.

Der Bediener muss Folgendes ausschalten:

–          Maschine

–          Strom

–          Licht.

In unserem Beispiel haben wir einen vollständigen einleitenden Satz. Artikel wurden in der Liste weggelassen, um dem Problem des Akkusativs auf dem Weg zu gehen. In der Liste wird empfohlen, immer mit einem Großbuchstaben zu beginnen. Kommata weglassen und die Liste mit einem Punkt abschließen.

Diese Regeln sind natürlich nur Vorschläge. In der Leitlinie „Regelbasiertes Schreiben“ der TEKOM auch mehrere Möglichkeiten vorgeschlagen. Der technische Redakteur muss sich jedoch für eine Regel entscheiden, um konsistent zu bleiben.

Stil

„Ich habe gemerkt, dass wir für den gleichen Satz, immer wieder Geld für die Übersetzung zahlen. Warum eigentlich?“ fragt Sabrina L.

„Wir haben keinen einheitlichen Stil und sagen in unterschiedlichen Worten immer das gleiche!“, erklärt Markus F.

Schlecht

Gut

Taste drücken.

Taste drücken.

Die Taste drücken.

Taste drücken.

Den Knopf drücken.

Taste drücken.

Den Knopf herunterdrücken.

Taste drücken.

„Dann sollten wir aber nicht nur die technischen Fachbegriffe in unserer Terminologiedatenbank festhalten, sondern auch allgemeinere Begriffe.“, stellt Sabrina L. fest.

Markus F. überlegt und stimmt Sabrina L. zu.

In diesem Teil haben Markus F. und Sabrina L. damit angefangen einen Style Guide aufzubauen, um in ihrem Redaktionssystem die Wiederverwendbarkeit zu erhöhen und um leserfreundlich zu sein.

Im nächsten Teil wird Sabrina L. mit einem Vorschlag zur Terminologieverwaltung kommen und Markus F. findet ein System, das Terminologie und technische Redaktion in einem CCMS verbindet.

Und dann geht es los mit einer neuen Arbeitsweise, die zu mehr Effizienz und zu Kosteneinsparungen führt.

Auch wir bieten Ihnen eine Beratung zum Redaktionsleitfaden an: bemodular

Suchen Sie ein System, das dem Redakteur beim Verwenden der Schreibregeln hilft, kontaktieren Sie unseren Partner: www.congree.com

Diesen Artikel teilen

Share on facebook
Share on xing
Share on twitter
Share on linkedin
Share on print
Share on email

Schreibe einen Kommentar