Redaktionssystem ja oder nein?

Sie wollen wissen, ob sich ein Redaktionssystem für Ihre Technische Redaktion lohnt? Hier finden Sie Antworten.

Redaktionssysteme haben viele Vorteile, z. B. können sie die Arbeit Ihrer Technischen Redaktion enorm erleichtern und zeitgleich die Qualität sowie den Output Ihrer Technischen Dokumentation erheblich steigern.

Der Heilige Gral der Technischen Dokumentation

Alle gängigen Redaktionssysteme sind XML-basiert. Das bedeutet in der Praxis, dass sie Texte und Inhalte "Layout-unabhängig" verarbeiten. Als Redakteur schreiben und gestalten Sie in einem mehr oder weniger komplexen Editor mit verschiedenen Vorschaumöglichkeiten. Das Redaktionssystem bietet Ihnen die Ausgabe dieser Inhalte in jedem nur denkbaren Format: PDF, Online-Hilfe, Mobile Documentation - immer im passenden Layout und Design, responsive, smart, modern.
Alles kein Problem für die Wunderwaffe des Single-Source-Publishing.

Glaubt man den Herstellern von Redaktionssystemen, so ist es unvorstellbar, wie eine Redaktion überhaupt jemals ohne ausgekommen ist. "Manuelle" Arbeit in Word oder InDesign ist demnach schon fast mit Hammer und Meißel gleichzusetzen.

Wann Sie unbedingt ein Redaktionssystem brauchen

Die Antwort ist vergleichsweise einfach: Sobald Sie den Überblick über Ihre Dokumente zu verlieren drohen, brauchen Sie ein Redaktionssystem.

Diese Aussage gilt für Global Player mit einer großen Technischen Redaktion ebenso wie für kleine mittelständische Unternehmen mit einer Ein-Mann-Redaktion. Denn auch der Einzelkämpfer ist nur ein Mensch mit begrenzter Leistungsfähigkeit.

Stellen Sie sich zwei Redakteure bei der Arbeit vor - nennen wir sie Emma und Paul.
Die Firma von Emma und Paul verkauft eine überschaubare Produktpalette von 5 Produkten. Diese haben jeweils zwei bis drei Ausstattungsvarianten, die aber in einer umfassenden Anleitung abgehandelt werden. Die Zielmärkte der Firma sind vor allem die DACH-Region und weitere EU-Länder.

In Europa gibt es aktuell 24 Amtssprachen.
Dadurch ergibt sich folgende Rechnung: 5 Produkte à X Versionen à 24 Sprachen.
Würde die Firma von Emma und Paul die Produktvarianten ebenfalls in eigenen Anleitungen pflegen, kämen die auf die Rechnung noch oben drauf. Auch Montage-, Wartungs- und Service-Anleitungen müssen mit der Anzahl multipliziert werden.

Der Aufwand und die Anzahl der Dokumente wachsen exponentiell, je mehr Einzel-Anleitungen es gibt. Und irgendwann ist der Punkt erreicht, an dem weder Emmas Organisationsgeschick, noch Pauls strukturierte Arbeitsweise oder ihre brillante Ablagestruktur sie retten werden. Die Beiden verlieren den Überblick im Dschungel der Technischen Dokumentation.

Die Folge ist, dass die Arbeit von Emma und Paul anfällig für Fehler wird.
In einer Anleitung haben sie vielleicht mal vergessen, einen Textbaustein in der Beschreibung zu ersetzen, aber an anderer Stelle haben sie einen veralteten Warnhinweis übersehen. Für die Firma von Emma und Paul wird dieser Dschungel zum Haftungsrisiko.

Emma und Paul brauchen ein Redaktionssystem, um gute Arbeit leisten zu können.
Nur mit einem Redaktionssystem können die Beiden den Überblick behalten und ihre Inhalte, Bausteine und Übersetzungen sinnvoll verwalten.

Wann Sie auch mit Hammer und Meißel effizient Anleitungen erstellen können

Auch Hammer und Meißel haben immer noch ihre Daseinsberechtigung: Solange Ihre Technische Redaktion zurecht kommt, brauchen Sie nicht zwingend ein Redaktionssystem. "Zurecht kommen" bedeutet, dass Ihre Redaktuere weiterhin termingerecht, verständliche Anleitungen produzieren können.

Sie können Ihre Technische Dokumentation auch unabhängig von einem Redaktionssystem weitgehend standardisieren, z. B. mit Vorlagen, wiederverwendbaren Textbausteinen, einheitlicher Arbeitsweise (Stichwort Redaktionsleitfaden) usw.
Hier ist vor allem das Wissen und die Erfahrung Ihrer Technischen Redakteure gefragt.

Als fiktives Beispiel schauen wir uns den Arbeitsalltag von Markus an.
Markus ist als Technischer Redakteur ausgebildet und arbeitet für ein kleines mittelständisches Unternehmen, dessen Hauptabsatzmarkt die DACH-Region ist. Nehmen wir an, seine Firma verkauft ausschließlich Sondermaschinen. Diese sind sich prinzipiell ähnlich, aber für jedes Projekt wird etwas Kundenspezifisches eingebaut, das in der Anleitung berücksichtigt werden muss.

Hier kann auch ein Redaktionssystem nicht wirklich weiterhelfen, da die Inhalte nicht Eins-zu-eins wiederverwendet werden können.

Markus ist ein echter Profi. Er setzt einen Redaktionsleitfaden auf, in dem genau geregelt ist, wer was wann wie für wen macht und wo welche Informationen von wem zu bekommen sind. Für das Terminologie-Management holt er alle Verantwortlichen aus den anderen Abteilungen (Marketing, Konstruktion, Vertrieb, etc.) mit ins Boot - denn Teamwork ist unabdingbar für gute Technische Dokumentation.

Anschließend erstellt Markus eine Word-Vorlage, die bereits folgende Inhalte enthält:

  • Deckblatt
  • Gliederung und Struktur
  • Kopf- und Fußzeilen
  • Variablen, z. B. für den Produktnamen
  • Formatvorlagen
  • Textbausteine für Warnhinweise
  • Platzhalter für Grafiken
  • alle Inhalte, die standardmäßig identisch sind

Das Ergebnis kann sich sehen lassen. Denn immer, wenn Markus eine Anleitung für ein neues Produkt erstellt, ist diese Dank der Vorlage in überschaubarer Zeit angepasst und gleicht in Aufbau und Layout allen weiteren Anleitungen des Unternehmens.
Auch der Prüfprozess wird immens reduziert, da Standard-Texte, die bereits freigegeben sind, nicht jedes Mal durchgelesen werden müssen, sondern nur die Abschnitte geprüft werden müssen, in denen die Sonderfunktionen der Maschine beschrieben sind.

Die Vorgehensweise von Markus ist möglich, da er weder Produktvarianten noch viele Übersetzungen verwalten muss.

Fazit

Ob Sie ein Redaktionssystem sinnvoll nutzen können, hängt von verschiedenen Faktoren ab.
Zum einen spielen die Anzahl und der Umfang Ihrer Dokumente die größte Rolle. Zum anderen müssen sowohl Ihr Redaktionsprozess als auch Ihre Produkte dazu passen.

Wenn Sie kaum wiederverwendbare Inhalte in Ihren Anleitungen haben, weil jedes Produkt schon fast als Unikat bezeichnet werden kann, wird auch das mächtigste Redaktionssystem Ihnen nur wenig Arbeitserleichterung bringen können.

Wollen Sie es genau wissen, fragen Sie Ihre Technischen Redakteure. Sie sind die Spezialisten und werden Ihnen recht einfach und faktenbasiert Auskunft geben können. Manchmal muss man nicht mehr Personal einstellen, sondern einfach nur richtige Werkzeuge zur Verfügung stellen.

Alternativ analysieren die Handbuch Experten Ihre Prozesse mit dem Blick von außen für Sie und zeigen Optimierungspotential und Alternativen auf.

Jetzt Analyse Ihres Redaktionsprozesses anfordern!

Weitere Artikel, die Sie interessieren könnten