Die Technische Dokumentation im Wandel – Wie moderne Redaktionssysteme helfen, den steigenden Anforderungen zu begegnen

Zurück zur Übersicht
18.07.2017

Veröffentlichung vom 13.04.2005

Die Ansprüche an Technische Dokumente und Dokumentationen haben sich in den vergangenen Jahren stark verändert - die Arbeitsweise in vielen Technischen Redaktionen ist dagegen im Wesentlichen gleich geblieben. Redaktionssysteme sollen Technische Redakteure dabei unterstützen, die Technische Dokumentation an die neuen Ansprüche anzupassen. Was sind nun die Anforderungen an Dokumentation und Redaktionsysteme? Und wie können sie am Beispiel docuglobe umgesetzt werden?

Von Ulrich Pelster

Inhalte

/  Neue Anforderungen an die Technische Dokumentation

/  Kriterien für Redaktionssysteme

/  Mehrfachverwendbarkeit

/  Verwaltbarkeit

/  Bedienbarkeit

/  Skalierbarkeit

/  Kostensenkung durch Redaktionssysteme

/  docuglobe als Beispiel für ein Redaktionssystem

/  docuglobe implementieren

/  docuglobe-Funktionen

/  docuglobe-Nutzen

docuglobe kann mehr als "nur" Technische Dokumentation

Neue Anforderungen an die Technische Dokumentation

Vor gar nicht allzu langer Zeit bestanden Technische Dokumentationen in der Regel aus einem dünnen Handbuch. Im Falle etwa einer Maschine wurden die wesentlichen Funktionen und Bedienelemente erläutert und Hinweise zur Wartung gegeben. Fremdsprachige Übersetzungen gab es allenfalls in Englisch und Französisch.

Mit dem flächendeckenden Einzug der Elektronik im Maschinen- und Anlagenbau in den 80-er Jahren, der Globalisierung der Märkte und zunehmender Standardisierung durch EU-Richtlinien, internationale Normen und Gesetze zur Produkthaftung veränderte sich jedoch das Anforderungsprofil an die Technische Dokumentation radikal. Für Exporteure in Länder außerhalb der EU ist zum Beispiel die Kenntnis der jeweils aktuellen nationalen Vorschriften für Sicherheitshinweise sehr wichtig. Während viele Unternehmen aber in moderne Fertigungsmethoden und Entwicklung sowie in intelligente Unternehmenssoftware und die Optimierung ihrer Geschäftsprozesse investierten, um wettbewerbsfähig zu bleiben, blieb in der Technischen Dokumentation meist alles beim Alten. Dokumente wurden und werden vielerorts bis heute mit einem Textverarbeitungsprogramm am PC erstellt, manchmal noch mit einem DTP-Programm gestaltet.

Gemessen an den oben formulierten Anforderungen ist ein solches Vorgehen längst nicht mehr wirtschaftlich. So schreibt etwa die Maschinenrichtlinie 98/37/EG Technische Dokumentation in der jeweiligen Sprache des Inbetriebnahmelandes vor. Für international tätige Unternehmen bedeutet dies, dass die Unterlagen in allen 19 EU-Sprachen jederzeit verfügbar sein müssen. Allein die Aufgabe, diese 19 Sprachversionen aktuell und konsistent zu halten, erfordert einen ungeheuren Aufwand und eine penible Versionskontrolle. Was passieren könnte, wenn in den meist nur mit ein bis zwei Mitarbeitern ausgestatteten Dokumentationsabteilungen ein Mitarbeiter zeitweise ausfällt oder durch einen anderen ersetzt werden muss, mag man sich gar nicht ausmalen.

Eine andere Herausforderung liegt in der rasanten Entwicklung von Informations- und Kommunikationstechnologien. Technische Dokumentationen sind heute längst nicht mehr nur aus Papier. Sie sind immer häufiger oder auch ganz und gar aus Bits und Bytes, kommen aus dem Internet oder per CD daher oder sind in vielen Fällen, in denen Maschinen mit eigenen Bildschirmen für die Programmierungseinheiten ausgestattet sind, gleich in das EDV-System der Maschine integriert. Spätestens hier stößt die herkömmliche Arbeitsweise in der Technischen Dokumentation an ihre Grenzen, wird sogar zum entscheidenden Wettbewerbsfaktor. Die Investition in ein modernes Redaktionssystem, das auf die Bedürfnisse der Technischen Dokumentation zugeschnitten ist, kann hier für erhebliche Entlastungen in den Bereichen Aufwand und Kosten sorgen und zugleich für eine deutlich verbesserte Qualität der Dokumentationen. Welche Kriterien muss ein solches System aber erfüllen, um die geforderte Leistung auch zu erbringen?

Kriterien für Redaktionssysteme

Mehrfachverwendbarkeit

Ein zentraler Aspekt der modernen Anforderungen an Technische Dokumentationen ist die Mehrfachverwendbarkeit von Inhalten. Und dies in zweierlei Hinsicht: Einmal innerhalb einer Dokumentenklasse. Die Spezifikation eines Elektromotors, der in gleicher Bauart in zwei verschiedenen Maschinen verwendet wird, muss im Prinzip nur einmal im Redaktionssystem vorhanden sein. Mehrfachverwendbarkeit kann aber auch bedeuten, dass ein und derselbe Inhalt für die Erzeugung verschiedenartiger Medien eingesetzt wird, etwa für eine herkömmliche Wartungsanleitung auf Papier und als Online-Hilfe. Ein modernes Redaktionssystem muss also in der Lage sein, einmal erstellte Inhalte für vielfache Anwendungszwecke zur Verfügung zu stellen.

Verwaltbarkeit

Ein zweiter zentraler Aspekt kommt an dieser Stelle hinzu. Für die Konsistenz der verschiedenen Dokumentationen, Sprachversionen und Medienvarianten ist es von entscheidender Bedeutung, dass die Zugrunde liegenden Inhalte an einer Stelle zentral gepflegt werden. Das heißt im Falle des Elektromotors: Ändert sich die Spezifikation, weil ein leistungsfähigeres Modell zum Einsatz kommt, sollten durch die einmalige Änderung des Basis-Inhaltes alle daraus generierten Dokumente aktualisiert werden. Nur so lassen sich signifikante Entlastungen realisieren.

Als probates Mittel zur Bewältigung dieser beiden zentralen Anforderungen hat sich die Modularisierung erwiesen. Nach dem Beispiel des LEGO-Baukastensystems werden Dokumenteninhalte dabei nach bestimmten Kriterien in einzelne Bausteine zerlegt. Diese Bausteine werden dann vom Redaktionssystem verwaltet und dienen in immer neuer Zusammensetzung zur Herstellung aller denkbaren Formen von Technischen Dokumentationen. Das Prinzip der Modularisierung ermöglicht die schnelle Anpassung von Dokumenten, da nur noch das oder die von einer Änderung betroffenen Teile eines Dokumentes aktualisiert werden müssen und sorgt dafür, dass diese Aktualisierung konsistent in allen Dokumentationen durchgeführt wird, in denen die fraglichen Module verwendet werden.

Bedienbarkeit

Wichtig ist natürlich auch die Frage der Bedienbarkeit eines Redaktionssystems. Bei aller Komplexität im Funktionsteil muss es in der Handhabung den Redakteuren vertraut und ohne großen Lernaufwand implementiert werden können. Im Regelfall bedeutet das, dass sich ein Redaktionssystem idealerweise in vorhandene Umgebungen einfügen - wie zum Beispiel MS Office© - und dort vorhandene Editoren nutzen sollte.

Skalierbarkeit

Welches der verschiedenen auf dem Markt befindlichen Systeme letztlich das optimale für den jeweiligen Anwenderbetrieb ist, muss sich natürlich von Fall zu Fall entscheiden. Wie diese Entscheidung ausfällt, ist nicht zuletzt immer auch eine Frage des Budgets. Als Kriterium sollte jedoch immer auch heran gezogen werden, ob die Software den eigentlichen Bedarf des Anwenders auch wirklich "versteht". Das bedeutet, eine Software sollte genau den Leistungsumfang bieten, der auch wirklich benötigt wird. Eine umfangreiche Lösung, die letztlich aber vom Funktionsumfang her nur partiell genutzt wird, ist nicht wirtschaftlich. Eine Lösung, die vielleicht noch nicht genutzte, aber für die Zukunft wichtige Features nicht bietet, ist eine Fehlinvestition. Vor dem Einsatz eines Redaktionssystems sollte also in jedem Fall eine Evaluierungs- und Beratungsphase stattfinden.

Kostensenkung durch Redaktionssysteme

Die Modularisierung technischer Dokumente wie Handbücher, Betriebs- und Wartungsanleitungen, soviel ist jetzt schon klar geworden, bietet enorme Potenziale zur Zeit- und Kosteneinsparung bei gleichzeitiger Verbesserung der Qualität der Dokumentationen. Angesichts des wachsenden Wettbewerbsdrucks vor allem auch auf den Mittelstand im Zuge der fortschreitenden Globalisierung können die Unternehmen daher in diesem Bereich durch Prozessoptimierung Kosten senken - und zwar bis zu 50 Prozent. Die Voraussetzung dafür ist eine intelligente Redaktionssoftware, mit der sich die einzelnen Informationsmodule verwalten und zu fertigen Dokumenten zusammenfügen lassen.

docuglobe als Beispiel für ein Redaktionssystem

Entwicklung aufgrund eigener Erfahrungen

Das eine solche Software leistungsfähig und kostengünstig zugleich sein kann - und damit gut geeignet für die schmalen Budgets vieler besonders von der Problematik betroffener Mittelständler - zeigt das Beispiel docuglobe. Das System wurde um das Jahr 2000 von der technotrans AG, einem Anbieter von Anlagen für die Herstellung von Printmedien und Mikrostrukturen mit rund 650 Mitarbeitern, für den eigenen Bedarf entwickelt, weil das Unternehmen am Markt keine Software fand, die seinen Bedürfnissen im Bereich der technischen Dokumentation seiner Produkte entsprach.

Das ursprünglich für den Eigenbedarf entwickelte docuglobe wird bei der technotrans AG mittlerweile in einem eigenen Geschäftsbereich geführt und weiterentwickelt. Es wird bereits bei über 40 Unternehmen mit Erfolg eingesetzt, darunter auch bei einer Reihe mittelständischer Betriebe.

docuglobe implementieren

docuglobe lässt sich "Out Of The Box" mit minimalem Aufwand implementieren und kann nach der Installation sofort produktiv arbeiten. Es ermöglicht das Arbeiten in gewohnter Umgebung und bietet ein sehr gutes Kosten/Nutzen-Verhältnis - nicht zuletzt deshalb, weil es aus der Perspektive eines Industrieunternehmens entstanden ist. Da man bei technotrans aus dem eigenen Leidensdruck heraus an die Entwicklung der Software ging, orientierten sich die Programmierer bei der Problemlösung vor allem an der täglichen Praxis, wie sie im eigenen Unternehmen vorzufinden war. Wie bei vielen mittelständischen Maschinenbau-Unternehmen bestand die Erstellung von Dokumentationen nämlich vorwiegend aus mühsamer und zeitraubender Handarbeit. Jede einzelne Dokumentation musste komplett neu angelegt, redigiert und gegebenenfalls übersetzt werden. Umständlich gestaltete sich vor allem die Suche nach bereits vorhandenen Inhalten in anderen Dokumentationen, die dann "zusammenkopiert" wurden. Jede Übersetzung musste zudem stets auf neue komplett auf korrekte Übereinstimmung mit dem deutschen Original überprüft werden. Bei Änderungen an den technischen Daten von ähnlichen Maschinentypen war zum Teil die Anpassung dutzender einzelner Dokumente notwendig - leicht schleichen sich hier Fehler ein.

Bei der Entwicklung von docuglobe nahm sich technotrans das Stücklistensystem zum Vorbild, wie es auch bei der Konstruktion von Maschinen und Anlagen verwendet wird, und übernahmen es als Konzept für den Bereich der Technischen Dokumentation. Das bedeutet, Inhalte werden als einzelne Informationsmodule in einer Baumstruktur ähnlich wie beim Windows Explorer verwaltet und als Modulliste zusammengestellt. Hier wird schon deutlich, dass es den Entwicklern auch auf eine intuitive Erlernbarkeit ihrer Software ankam. Darum entschied man sich auch dafür, als Editor für docuglobe das Programm Microsoft Word zu verwenden. Word ist wie kein anderes System in der Welt verbreitet, wodurch Probleme im Bereich Datenaustausch für Recherche, unternehmensinterner Workflow für z. B. Prüfungen und Freigaben, Übersetzungen usw. nicht entstehen. Es fallen keine zusätzlichen Lizenkosten an, man hat es "ohnehin auf dem Rechner". Für Word sprachen allerdings auch noch andere Gründe als seine praktisch weltweite Verbreitung und die Tatsache, dass es wohl nicht so schnell vom Markt verschwinden wird. Es dient nicht nur als Schnittstelle zu vielen weiteren Unternehmensbereichen und Übersetzungsdienstleistern, sondern unterstützt zum Beispiel auch zu hundert Prozent den Unicode-Standard - sehr wichtig für die Erstellung multilingualer Dokumentationen. Word 2003 ist außerdem in Verbindung mit docuglobe 4 ein vollwertiger xml-Editor und damit geeignet, auch als Basis für die Herstellung medienneutraler Inhalte zu dienen. Natürlich war man sich bei technotrans durchaus im Klaren, dass Word auch Schwächen hat, die für die Erstellung einer Technischen Dokumentation von großer Wichtigkeit sind. Genau hier setzt docuglobe an: docuglobe umgeht diese Schwächen wie beispielsweise das leidigen Zentral-Filialdokument-Thema, Steuerung von Abschnittswechseln in großen Dokumenten, Listenfunktionen, Kopf-, Fußzeilen usw.

docuglobe-Funktionen

Wie funktioniert docuglobe nun und was leistet es? Voraussetzung ist zunächst, dass die vorhandenen Inhalte beim Anwender modularisiert werden und docuglobe damit "gefüttert" wird. Diese Informationsmodule können dann beliebig zusammengestellt werden. Die Software übernimmt dabei automatisch die inhaltliche Gliederung samt Verzeichnissen und Index und stellt dem Anwender das neue Gesamtdokument global nutzbar als PDF-Version, als Online-Help (chm, html) oder als normales Word-Dokument zur Verfügung. Diese Mehrfachnutzung eines Inhaltes für verschiedene Medien und Ausgabeformate wird auch als Single Source-Publishing bezeichnet. Eine inhaltliche Änderung eines Informationsmoduls bewirkt die automatische Anpassung aller damit in Beziehung stehender Dokumente. Die Inhalte der Dokumente werden zentral gespeichert und mittels Stichwortsuche von allen Mitarbeitern gefunden, die eine entsprechende Zugriffsberechtigung haben. Soll ein neues Dokument generiert werden, übernimmt der Anwender die notwendigen Informationsmodule per drag & drop aus der Baumstruktur und stellt so das Dokument zusammen. Diese Vorgehensweise sorgt dafür, dass vorhandene Inhalte - einmal erstellt - vielfach genutzt werden können. Der Anwender profitiert dabei von dem intelligenten Linkmanagement im Onlinehilfebereich und der aus Erfahrung gewachsenen Versionierungsphilosophie von docuglobe.

docuglobe-Nutzen

Welche Zeitersparnis bei gleichzeitigem Qualitätsgewinn realisiert werden kann, wird besonders am Beispiel mehrsprachiger Dokumentationen deutlich. Allein innerhalb der EU können 19 Sprachversionen ein und derselben Dokumentation notwendig werden. Um hier bei Änderungen sicher zu gehen, dass keine Inkonsistenzen entstehen, muss bei herkömmlicher Arbeitsweise jedes Mal ein Übersetzungsbüro mit dem Abgleich der Dokumente beauftragt werden. Mit docuglobe ist es nur noch ein einzelnes Modul mit eng umrissenem Inhalt. Auch das Ändern und Einpflegen sonstiger Inhalte wie zum Beispiel Grafiken und Tabellen wird deutlich beschleunigt. Erfahrungen bei mittelständischen Unternehmen zeigen, dass die Bearbeitungszeiten um die Hälfte und manchmal sogar bis auf ein Drittel der vorher benötigten Zeit sinken. Hinzu kommen eine deutliche Senkung der Fehlerquote und eine bessere Durchgängigkeit über alle Sprachen hinweg. Docuglobe unterstützt auf diese Weise das Qualitätsmanagement in einem Unternehmen.

Inzwischen wird die Software bei der technotrans AG nicht nur in der technischen Dokumentation eingesetzt, sondern auch in den Abteilungen Qualitätsmanagement, Entwicklung, Produktionsplanung, Mitarbeiterschulung, IT und im Vertrieb. Denn es hat sich gezeigt, dass durch die Modularisierung von Dokumenten und Inhalten auch andere Prozesse effizienter und damit kostengünstiger gestaltet werden können. Jeder kennt die "normale" Vorgehensweise: Man sucht bei Bedarf ein bestehendes Dokument, ändert die vorgangsspezifischen Inhalte oder kopiert sie aus verschiedenen Dokumenten zusammen und wählt "Speichern unter". Das dies über kurz oder lang zu einem Wust verschiedener Versionen von Dokumenten führt, der nicht mehr zu überblicken und zu bewältigen ist, liegt auf der Hand. Hinzu kommt, dass diese Vielzahl an Dokumenten und Inhalten auf einem weitgehend redundanten Datenbestand beruht - von den Kosten für die Verwaltung und der Qualität der Dokumente ganz zu schweigen.

docuglobe kann mehr als "nur" Technische Dokumentation

Daher legt das Unternehmen bei der Vermarktung seines Produktes den Fokus längst nicht mehr ausschließlich auf die technische Dokumentation. In Vertriebsabteilungen von Unternehmen zum Beispiel werden Angebote geschrieben, die grundsätzlich alle den gleichen Aufbau haben und zu großen Teilen aus immer wieder verwendeten Inhalten bestehen. Mit docuglobe werden diese Inhalte einfach per Drag&Drop zu einem individuellen Angebot zusammengestellt. Die Verwaltung selbst sowie Adress- und Preisinformationen kommen aus dem angekoppelten CRM- und ERP-System. Ein anderes Einsatzgebiet ist das Qualitätsmanagement. Bei der Erstellung von Verfahrens- und Arbeitsanweisungen gibt es Inhalte, die abteilungsbezogen in verschiedenen Dokumenten immer wieder Verwendung finden. Innerhalb von Prüfanweisungen sind bestimmte Prüfschritte immer gleich. Durch die Modularisierung der Handlungsanweisungen können diese den einzelnen Dokumenten gezielt zugeordnet werden. Muss beispielsweise eine Handlungsanweisung aufgrund geänderter Prüfmittel angepasst werden, sind sämtliche damit in Verbindung stehende Prüfanweisungen ohne weiteren Aufwand aktualisiert. Andere mögliche Anwendungsbereiche sind Konstruktionsabteilungen, das Personal- und Rechtswesen sowie IT- und Serviceabteilungen.

E-Mail schreiben
Anrufen
Beratungstermin buchen
Anfrage senden