5 Gründe, warum Sie Ihre Technische Dokumentation nicht in Word verwalten sollten

Ist Word wirklich das richtige Tool? Kann ein Textverarbeitungsprogramm die Anforderungen an die Erstellung und Verwaltung Ihrer Technischen Dokumentation erfüllen? Wahrscheinlich haben Sie bereits ein vages Gefühl, das dem nicht so ist. Sonst wären Sie nicht hier. 

Und Sie haben Recht: Textverarbeitungsprogramme wie Microsoft Word sind leistungsstarke Tools für eine Vielzahl von Aufgaben – die Erstellung und Verwaltung Ihrer technischen Dokumentation gehört leider nicht dazu. 

In diesem Artikel besprechen wir fünf Gründe, warum Sie Ihre Technische Dokumentation nicht in Word verwalten sollten und stellen Ihnen bessere Alternativen vor, mit denen Sie nicht nur Zeit und Geld, sondern auch Nerven sparen. 

Die 5 größten Nachteile von MS Word für die Technische Dokumentation (TD) 

1. Mühsame Versionsverwaltung 

Die akkurate Versionsverwaltung, auch als Versioning bezeichnet, ist eine der Hauptanforderungen an die Technische Dokumentation. Hersteller von Produkten und Software sind dazu gesetzlich verpflichtet. Jede Produktänderung muss aufgezeichnet und nachvollziehbar bleiben. 

Textverarbeitungsprogramme wie Microsoft Word erfüllen diese Anforderungen nur unzureichend. In der Cloud-Version von MS Word lässt sich eine Versionsverwaltung theoretisch einrichten, aber die praktische Umsetzung scheitert häufig. Prozesse und Standards für die Dateispeicherung müssen definiert und implementiert werden. 

Doch je komplizierter ein System, desto höher seine Fehleranfälligkeit. Können Sie sicherstellen, dass alle Beteiligten die nötige Disziplin aufbringen, um die festgelegten Verfahren an die Dateispeicherung einzuhalten? Wenn das nicht gewährleistet ist, eignet sich eine Software, die speziell für dieses Anwendungsszenario konzipiert wurde, wesentlich besser. So lassen sich Fehler und deren Konsequenzen von vornherein vermeiden. 

2. Uneingeschränkter Dateizugriff 

Wissen Sie eigentlich, wer Zugriff auf Ihre technische Dokumentation hat? Jeder im Unternehmen? Nur eine bestimmte Gruppe? Auch der Praktikant? Dürfen all diese Nutzer auch Änderungen vornehmen oder die Datei sogar löschen? 

Selbst wenn Ihre technische Dokumentation in der Cloud gespeichert wird, besteht oft die Möglichkeit, dass ein Mitarbeiter die Datei herunterlädt, bearbeitet und wieder hochlädt. Auch in diesem Fall wird es Probleme mit der Änderungsnachverfolgung und Versionsverwaltung geben. 

3. Risiko des Datenverlusts 

Ein uneingeschränkter Dateizugriff oder eine mangelnde Verwaltung der Nutzerrechte, wie oben angesprochen, erhöht auch das Risiko eines Datenverlusts. Eine Datei oder ein Ordner lässt sich schnell löschen oder aus Versehen in einen anderen Ordner – auf Nimmerwiedersehen – verschieben. 

4. Inkonsistenzen bei Form und Layout 

Eine der nützlichsten und beliebtesten Funktionen in Textverarbeitungsprogrammen sind die zahllosen Formatierungsmöglichkeiten. Benutzer können die Textgröße, die Schriftart, den Zeilenabstand und vieles mehr nach Belieben anpassen. 

Persönliche Präferenzen der Benutzer sollten bei der Erstellung und Verwaltung Ihrer technischen Dokumentation jedoch weitestgehend ausgeschlossen werden. 

Warum? Die Maschinenrichtlinie (2006/42/EG) schreibt beispielsweise vor, dass Signalwörter, die auf Sicherheitsrisiken in einer Bedienungsanleitung verweisen – wie GEFAHR, WARNUNG oder VORSICHT – generell in Großbuchstaben und ohne Ausrufezeichen zu setzen sind. 

Ihr Technischer Redakteur ist mit diesen Normen und Richtlinien vertraut, ein anderer Nutzer, der diese Formatierung womöglich nach seinen Präferenzen anpasst, vielleicht nicht. Abhilfe schafft hier ein Tool, das genau für diesen Zweck entworfen worden ist und den Autoren die richtige Formatierung, wie für die oben genannten Signalwörter, automatisch vorschlägt.   

Ihre technische Dokumentation reflektiert außerdem das Branding Ihres Unternehmens. Sie sollten daher ausschließen, dass Teammitglieder den Look Ihrer Dokumente verwässern können. 

5. Layout- und Formatierungsprobleme nach einer Übersetzung 

Hersteller, die ihre Produkte auch im Ausland vertreiben wollen, müssen Ihre Technische Dokumentation in die Zielsprache der entsprechenden Länder übersetzen. 

Übersetzungen einer Word-Datei werden schnell zum Alptraum des DTP-Teams, das die Druckvorlage erstellt. Insbesondere, wenn die Ausgangsdatei schlecht formatiert und Absätze beispielsweise mit Tabs oder Leerzeichen eingerückt worden sind. 

Ihre Texte sind in verschiedenen Sprachen unterschiedlich lang: Im Englischen etwa voraussichtlich kürzer als im Deutschen, im Spanischen dagegen länger. Eine Übersetzung wird in diesem Fall das gesamte Layout verschieben und Ihre DTP-Mitarbeiter werden sehr viel Zeit für die manuelle Formatierung jedes einzelnen Dokuments aufbringen müssen. 

Zum Glück gibt es inzwischen hervorragende Alternativen für die Erstellung und Verwaltung Ihrer Technischen Dokumentation, die wir Ihnen nachfolgend vorstellen. 

Die Vorteile von Content-Management-Systemen (CMS) 

Ein Content-Management-System (CMS) für die Technische Dokumentation, auch Redaktionssystem genannt – nicht zu verwechseln mit CMS für Webseiten –, ist eine datenbankgestützte Software, in der Inhalte gemeinschaftlich erstellt, bearbeitet und verwaltet werden. Inhaltsmodule werden einmalig erstellt und lassen sich anschließend beliebig wiederverwenden. 

Ein CMS ist einem Textverarbeitungsprogramm weit überlegen und bietet Herstellern und Technischen Redakteuren enorm viele Vorteile: 

• Eine Single-Source-of-Truth: Dank der zentralen Speicherung der Daten greifen alle autorisierten Nutzer auf den gleichen, stets aktuellen Datensatz zu. Redundante und doppelte Datensätze und Dateien lassen sich damit vermeiden.  

• Versioning: Jegliche Datenänderung wird in der Historie des CMS gespeichert und lässt sich bei Bedarf sogar rückgängig machen. 

• Unterschiedliche Zugriffsrechte: In einem CMS können Nutzern verschiedene Rollen mit unterschiedlichen Berechtigungen, wie Administrator, Editor, Leser, zugewiesen werden. Auf diese Weise wird die Sicherheit der Dateien erhöht. 

• Weniger Fehlerquellen: Da einmal erstellte und geprüfte Inhalte wiederverwendet werden, wird das Fehlerrisiko verringert. 

• Zusammenstellung von Dokumenten anhand einzelner Module: Da sich Module wie Puzzlestücke verwenden lassen, wird die Erstellung ähnlicher Dokumente etwa bei Produktupdates zum Kinderspiel. 

• Publizierung in unterschiedlichen Zielformaten: Die Inhalte in einem Redaktionssystems lassen sich als PDF, als Online-Hilfe oder sogar als Chatbot publizieren. 

Die Nutzung eines CMS ist eine tolle Sache. Aber mit zunehmender Anzahl an Inhalten, technischen Abbildungen und Sprachen kommen diese Lösungen an ihre Grenze. Die Lösung? Component-Content-Management-Systeme (CCMS). 

Component-Content-Management-Systeme (CCMS)  

Was sind Component-Content-Management-Systeme (CCMS) 

Ein Component-Content-Management-System (CCMS) ist ein Content-Management-System, das Inhalte auf Komponentenebene anstatt auf Dokumentenebene verwaltet. Komponenten sind kleine Informationsbausteine, wie eine einzelne Abbildung, eine Tabelle oder eine Produktbeschreibung, die sich beliebig kombinieren und wiederverwenden lassen. 

Die Vorteile eines Component-Content-Management-Systems 

Lassen Sie uns die Vorteile eines CCMS anhand eines praktischen Beispiels erläutern. Angenommen Sie sind deutscher Hersteller einer Kaffeemaschine und bieten zwei beinahe identische Modelle an – eines mit und eines ohne Milchaufschäumer –, die Sie in zehn europäischen Ländern verkaufen wollen. 

In einem CCMS müssen alle Inhaltsbausteine nur einmal erstellt werden. Das heißt, Sie als Hersteller schreiben eine allgemeine Bedienungsanleitung für beide Modelle. Nur die Stellen, an denen sich die Modelle unterscheiden, müssen separat angelegt werden, wie die Produktabbildungen, die Lieferinhalte und die Hinweise zur Verwendung und Wartung des Milchaufschäumers. 

Auf diese Weise lassen sich beide Bedienungsanleitungen ohne viel Aufwand in zehn Sprachen übersetzen. Alle notwendigen Inhaltsbausteine können mühelos in ein übersetzerfreundliches Dateiformat exportiert werden. Nach der Übersetzung werden diese Daten im CCMS hinterlegt und sind sofort verfügbar. 

Mit einem Klick lassen sich aus diesen Inhaltsbausteinen 20 komplette Bedienungsanleitungen in zehn Sprachen generieren – mit minimalem Aufwand für den technischen Redakteur – und mit geringeren Betriebskosten für das Unternehmen. 

Hersteller, die mit einem CCMS arbeiten, entlasten den technischen Redakteur, das DTP-Team und den Übersetzungskoordinator und profitieren von: 

• geringeren Produktionskosten, 

• niedrigeren Übersetzungskosten, 

• schnelleren Abläufen und 

• agilem Arbeiten. 

Neben diesem sogenannten Variantenmanagement bietet ein solches Redaktionssystem noch viele weitere Vorteile: 

• Wiederverwendbarkeit von Informationen 

• Leichte Auffindbarkeit von Inhalten 

• Versionierung 

• Standardisiertes Layout 

• Trennung von Inhalt und Layout 

• Sprachenmanagement 

• Bessere Zugänglichkeit für Personen mit eingeschränkter Sehfähigkeit 

• Direktes Feedback bei einer HTML-Ausgabe 

• Qualitätssicherung 

• Automatisierung 

• Möglicher Einsatz von Künstlicher Intelligenz wie Chatbots. 

Lexsys: Ihr zuverlässiger Partner für technische Dokumentation  

Für Einsteiger in die Technische Dokumentation mag ein Textverarbeitungsprogramm wie Microsoft Word die erste Wahl sein. Jeder kennt sich damit aus und Dokumente lassen sich rasch erstellen. 

Doch je komplexer Ihre Anforderungen werden, desto schlechter schneidet solch eine Software ab. Die mangelnde Versionsverwaltung und der uneingeschränkte Dateizugriff erhöhen das Risiko von Datenverlust, Inkonsistenzen bei Form und Layout sowie Formatierungsprobleme nach einer Übersetzung. 

Eigenständige Lösungen wie Adobe FrameMaker bieten einige der Vorteile eines CCMS. Doch Redaktionssysteme wie ein Component-Content-Management-System (CCMS) sind definitiv die bessere Alternative und bieten Herstellern unschlagbare Vorteile. 

Wir bei Lexsys unterstützen Hersteller gern bei der Erstellung, Verwaltung und Übersetzung ihrer Technischen Dokumentation in einem CMS oder CCMS. Unsere Projektmanager sind mit Redaktionssystemen bestens vertraut und können Sie diesbezüglich auch gern beraten. 

Wollen Sie mehr darüber erfahren, wie Lexsys Sie bei Ihren technischen Dokumentationen unterstützen kann? Kontaktieren Sie uns noch heute und vereinbaren Sie ein Beratungsgespräch.