Herr Maier ist ein erfahrener technischer Redakteur in einem mittelständischen Maschinenbauunternehmen. Im Laufe der Jahre hat sich die Firma und somit auch die Produkte weiterentwickelt: Die ehemaligen „Standardlösungen“ gibt es so nicht mehr. Komplexere Lösungen sind gefragt, und zwar in verschiedenen Varianten. Das Unternehmen ist auf das Motto „flexibel aber schnell“ umgestiegen. Nach und nach aktualisiert Herr Maier und erstellt mit Hilfe von Copy & Paste neue Handbücher.
Eine weitere Schwierigkeit ist, dass Herr Maier die Dokumentation immer wieder in die verschiedensten Sprachen übersetzen lassen muss, denn die deutschen und englischen Versionen waren nicht mehr ausreichend. Ein weiteres Problem sind die unterschiedlichen Standards und Gesetze, die je nach Land beachtet werden müssen.
Das ganze Umschreiben und Anpassen bedeutet Arbeit. Das kann Herr Maier nur in einem Team schaffen. Und als ob das ganze Anpassen nicht schon ausreichen würde… Kunden fragen nun nicht nur Anleitungen an. Die Anforderungen sind:
• Layout mit dem Anwenderfirmenlogo
• Schulungsunterlagen
• Multimedia-Formate
• Online-Hilfe
• HTML-Anleitungen
Jetzt muss Herr Maier auch noch die Dokumente irgendwie in verschiedene Formate bringen.
Inzwischen verliert Herr Maier die Kontrolle über die gesamte Situation. Die Originale und Übersetzungen liegen in unterschiedlichen Formaten vor. Die Übersetzungskosten sind hoch und die Umwandlung in digitale Formate ist sehr zeitaufwändig. Nun steht das Wochenende an und die Sonne scheint. Aber… einer der wichtigsten Kunden des Unternehmens schickt am Freitag einen Bericht mit einigen Fehlern in der technischen Dokumentation. Nach einem kurzen Gespräch mit seinen Kollegen identifiziert Herr Maier 10 Absätze auf insgesamt 5 Seiten, die in dem vom Kunden zugesandten Musterdokument geändert werden sollen. Das ist doch schnell gemacht! Der Vertrieb hat dem Kunden daher versichert, dass die vorhandenen Unterlagen bis Montagmorgen auf dem Unternehmensportal verfügbar sein werden.
Aber das ist doch nicht machbar! Herr Maier kann nicht mehr zurückführen, in welchen Dokumenten dieser Fehler erstmals aufgetreten ist. In welchen Formaten, Versionen, Varianten, Märkten wurde das fehlerhafte Dokument wiederverwendet? Und selbst wenn er dazu in der Lage wäre alles zu korrigieren, wie sollen sie das mit der Übersetzung handhaben?
Herr Maier arbeitet das gesamte Wochenende durch und ist nun auf der Suche nach einer dauerhaften Lösung. Gibt es eine Software, die das Problem lösen könnte?
Aber wie sieht eines solche Lösung aus?
Das Schlüsselwort Information 4.0.
Modularisierung 4.0
Unkontrollierte Fehler in der technischen Dokumentation
Herr Maier hat das ganze Wochenende daran gearbeitet, Fehler in der bestehenden Dokumentation einer der größten Kunden seines
Unternehmens zu beheben. Er verbrachte Stunden damit, die Dokumentation über Copy und Paste zu überarbeiten.
Am Montagmorgen war Herr Maier immer noch daran und die Übersetzungen fehlten natürlich auch noch. Sein Chef war alles andere als begeistert. Und das erhöhte noch mehr die Frustration.
Da Herr Maier auf dem Markt keine Redaktionssoftware finden konnte, die das Verwalten der Veränderungen schell lösen konnte, beschloss er über die Arbeitsweise der technischen Dokumentation nachzudenken.
Single source content
Und dann kam ihm die Lösung: Das Problem ist, dass er seit Jahren keine qualitativ hochwertigen Originalinhalte erstellt hatte. Und warum? Copy & Paste, also Kopieren & Einfügen und Zeitdruck.
Deshalb wurden oft neue Inhalte geschrieben, statt diese wiederzuverwenden. Das hatte unnötige Übersetzungskosten zur Folge und war nicht unbedingt fördernd für die Qualität der Dokumentation.
Das bedeutet Ineffizienz.
Aber....
Die Lösung heißt Single Source Content: Jeder Originalinhalt existiert einmal und wird nicht dupliziert, sondern mit anderen Originalinhalten kombiniert, um verschiedene Dokumente zu erstellen.
Geht das auch ohne die Software zu wechseln?
Module und Fragmente
Nach einigen Versuchen steht fest: Das Prinzip der Single-Source-Inhalte ist zwangsläufig mit der Generierung von eigenständigen Content-Modulen kombiniert, die flexibel zusammengestellt werden können.
Das erste praktische Problem ist die Menge der Informationen, die in jedem Modul enthalten sind. Einige sehr lange Informationsblöcke (z.B. einige Standardkapitel) werden vollständig wiederverwendet und haben mehrere Seiten.
Andere Inhalte sind hingegen Textfragmente, die in der gesamten technischen Dokumentation mehrfach wiederholt werden.
Herr Maier merkt aber direkt, dass diese Vorgehensweise mit der aktuellen Software nicht umsetzbar ist. Um Module in ihrer Software zu erstellen, beschließt er deshalb die Module auf eine Seite zu reduzieren. Fragmente sind leider nicht möglich. Aber: Nicht alle Module sind genau eine Seite lang. Deshalb sind einige Seiten halb leer. Das Layout ist deshalb nicht sehr leserfreundlich.
Ein Puzzle
Herr Maier möchte nun noch einen Schritt weiter gehen. Er möchte die Module in Ordner speichern und katalogisieren.
Dank der neuen Ordner und Unterordner kann nun Herr Maier die einzelnen Module finden und wiederverwenden.
Aber die Erstellung und Organisation der Module, die einem Puzzle gleichen, gestaltet sich schwieriger als erwartet. Im nächsten Schritt überlegt Herr Maier, wie er Metadaten und Taxonomien in sein System einbauen kann.
Herr Maier hat nun eine Ordnerstruktur. Jetzt möchte er Metadaten definieren. Das sind Eigenschaften, die das Modul ausmachen. Er denkt darüber nach. Er gibt den Modulen klare Namen, die Ordner bekommen ebenfalls Namen. Die Namen gehen von der Produktreihe bis zur Item-Nummer. Er kann dank dieser Namen, oder auch Metadaten genannt, nun problemlos seine Dokumentation zusammenstellen.
Aber er möchte weg vom alten System und noch mehr automatisieren. Deswegen hat er sich auf die Suche nach verschiedenen Systemen gemacht und hat nun auch schon verschiedene Angebote vorliegen.
Die meisten Software-Anbieter haben aber keinen wirklichen Endpreis angegeben. Sie weisen darauf hin, dass ein Use Case nötig ist, um die Anforderungen zu definieren.
Herr Maier zieht die Marketing-Abteilung hinzu. Sie machen sich gleich an die Arbeit. Sie analysieren ihre Probleme anhand einer Tabelle:
Viele allgemeine Texte in verschiedenen Anleitungen
- Produktkonfigurationen, die einen geringen Einfluss auf das Gesamtdokument haben
- Optionen, die der Kunde auswählen kann
- Verschiedene Formate – PDF aber auch Web
- Automatische Korrektur der Single-Source-Knoten
- Versionierung
- Abweichungen durch verschiedene Märkte
- Verwaltung der Übersetzung
- Terminologie
Aber was bedeutet das alles?
Herr Maier versucht darauf zu antworten:
|
Fragen |
Antworten |
|
Viele allgemeine Texte in verschiedenen Anleitungen
|
· Ja – bisher immer Copy & Paste |
|
Produktkonfigurationen, die einen geringen Einfluss auf das Gesamtdokument haben
|
· Ja – eventuell. |
|
Optionen, die der Kunde auswählen kann
|
· Ja, wir haben Optionen. |
|
Verschiedene Formate – PDF aber auch Web
|
· Momentan veröffentlichen wir alles in PDF. · Andere Formate wären hilfreich. |
|
Automatische Korrektur der Single-Source-Knoten
|
· Single-Source haben wir jetzt. |
|
Versionierung
|
· Momentan manuell |
|
Abweichungen durch verschiedene Märkte
|
· Europa/Amerika/Asien |
|
Verwaltung der Übersetzung
|
· Unsere Übersetzungsagentur kümmert sich um die Übersetzung. Wir haben keinen Überblick über die Kosten. |
|
Terminologie
|
· Wir haben ein paar Listen |
Er sendet seine Antworten allen Software-Anbietern zu. Ein Software-Hersteller antwortet prompt und bietet einen kostenlosen Test an.
Herr Maier freut sich. Er antwortet umgehend und bittet um eine Testversion. Während er die Testversion auf seinem Computer einrichtet, bekommt Herr Maier eine weitere Antwort mit weiteren Fragen
und den Vorschlag einer Demo.
|
Fragen |
Antworten H. Maier |
Software-Anbieter |
|
Viele allgemeine Texte in verschiedenen Anleitungen |
Ja – bisher immer Copy & Paste |
|
|
Produktkonfigurationen, die einen geringen Einfluss auf das Gesamtdokument haben |
Ja – eventuell. |
· Woher kommen die technischen Daten? Nutzen Sie in Ihrer Firma ein PLM? · Wie werden Ihre Produktkonfigurationen erstellt? Gibt es einen Konfigurator? |
|
Optionen, die der Kunde auswählen kann
|
Ja, wir haben Optionen. |
· Sind die Optionen Standard-Optionen? · Hat jede Option Standard-Texte? |
|
Verschiedene Formate – PDF aber auch Web
|
Momentan veröffentlichen wir alles in PDF. Andere Formate wären hilfreich. |
· Welche Software verwenden Sie momentan? · Haben Sie Standard-Layouts? |
|
Automatische Korrektur der Single-Source-Knoten
|
Single-Source haben wir jetzt. |
Möglich durch Wiederverwendungen. |
|
Versionierung
|
Momentan manuell |
· Haben Sie einen genauen Workflow? |
|
Abweichungen durch verschiedene Märkte
|
Europa/Amerika/Asien |
· Textliche Abweichungen? · Abbildungen? |
|
Verwaltung der Übersetzung
|
Unsere Übersetzungsagentur kümmert sich um die Übersetzung. Wir haben keinen Überblick über die Kosten. |
· In welche Sprachen übersetzen Sie? |
|
Terminologie
|
Wir haben ein paar Listen. |
· Möchten Sie ein Authoring Help für mehr Brand Identity? |
Test-System
Herr Maier hat inzwischen alles eingerichtet. Das System ist mit MS Word verbunden und hat Makros, die in Word das Dokument automatisch erstellen. Er liest nach und nach seine Knoten ein. Nun
möchte er Metadaten und Taxonomien einrichten. Es gibt dazu keine wirkliche Funktion. Er kann alles wieder nur über die Ordnerstruktur und die Dateinamen organisieren.
Mit Hilfe von Templates kann er nun seine Knoten wiederverwenden und MS Word erstellt automatisch das Dokument, aber irgendwie dauert das ganze lange. Und nun liest er die Übersetzungen ein. Das
Ganze funktioniert ganz gut. Man muss sie hinterher aber noch in MS Word nacharbeiten, da jede Sprache eine andere Länge hat.
Momentan liegt ihm ein Beispiel-Layout vor. Er überlegt, ob die Erstellung auch in anderen Layouts möglich ist. Das wäre natürlich super! Er kontaktiert den Software-Anbieter. Die Antwort kommt
sofort:
Nein, sie müssen sich auf ein Layout festlegen.
Das schränkt Herr Maier dann natürlich wieder ein. Er möchte ja nicht immer nur in PDF publizieren. Die anderen Anbieter haben dann auch noch von verschiedenen Themen gesprochen:
• Filter
• Dita
• iiRDS
• Videos in technischer Dokumentation
• Integrationen mit anderen Systemen
• XML
• Workflow
• Versionierung
In unserem nächsten Blog versucht Herr Maier noch weiter seine bestehende Dokumentation mit Schreibregeln zu verbessern. Und er ist natürlich weiterhin auf der Suche nach dem passenden System.
Redaktionsleitfaden 4.0
Das Testsystem funktioniert, auch wenn Herr Maier immer noch auf der Suche nach dem passenden System ist. Jetzt kommt ihm aber noch eine Idee: Wenn ich meine Dokumente in ein CCMS einlese, dann nicht nur in einer klaren Struktur, sondern nach Schreibregeln. Hatten die Anbieter nicht etwas von Authoring Assistance gesagt?
Regeln sind alles!
Herr Maier möchte sich erst einmal auf grammatikalische und stilistische Regeln 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.
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!“. Wenn er Simplified Technical English lernt, könnte er ja auch direkt die
Dokumentation, wenn nötig auf Englisch schreiben.
Er nimmt sich einen übersetzten Text und versucht diesen anhand der Regeln 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.
|
Als nächsten Schritt möchte er nun die Regeln ins Deutsche übertragen.
Style guide
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.
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
Aber nummerierte Listen sind eigentlich keine Grammatik. Als nächsten Schritt möchte Herr Maier die Struktur und den Aufbau 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:
ausschalten. |
Der Bediener muss Folgendes ausschalten:
|
In unserem Beispiel haben wir einen vollständigen einleitenden Satz. Artikel wurden in der Liste weggelassen, um dem Problem des Akkusativs aus dem Weg zu gehen. In der Liste wird empfohlen, immer mit einem Großbuchstaben zu beginnen. Kommata wegzulassen und die Liste mit einem Punkt abzuschließen.
Diese Regeln sind natürlich nur Vorschläge. In der Leitlinie „Regelbasiertes Schreiben“ der TEKOM sind mehrere Möglichkeiten vorgeschlagen. Der
technische Redakteur muss sich jedoch für eine Regel entscheiden, um konsistent zu bleiben.
Stil
Und so kann man auch noch Übersetzungskosten einsparen:
|
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. |
Wie in STE möchte nun Herr Maier die technischen Begriffe festlegen.
Im nächsten Teil sucht Herr Maier nun ein System, das Terminologie, technische Redaktion und verschiedene Layouts in einem CCMS verbindet.