Dokumentation optimieren – Möglichkeiten und Grenzen ohne Redaktionssystem
Viele Technik-Redaktionen arbeiten an der Entwicklung einer automatisierbaren Dokumentation. Einen Weg dorthin mit möglichst einfachen Mitteln – zumindest bis zur sinnvollen Einführung eines Redaktionssystems – wollen wir in diesem Beitrag skizzieren. Er beschreibt einige Ansätze, mit denen Sie Ihre Dokumentation für die Einführung eines Redaktionssystems vorbereiten können.
Ausgangszenario
Von der organisch gewachsenen Dokumentensammlung zur automatisierbaren Dokumentation
Schauen wir zu Beginn kurz auf Ihren möglichen Stand der Dokumentation. Viele Technik-Redakteure finden sich in dem folgenden Szenario wieder:
„Wir haben eine Reihe von Dokumenten aus der Vergangenheit. Diese enthalten Passagen, die ähnlich in vielen Dokumenten vorkommen. Gleichzeitig sind große Teile der Dokumente jedoch individuell. In der Vergangenheit haben wir neue Dokumente erstellt, indem wir bestehende Dokumente kopiert und geändert haben. Bei Bedarf haben wir Teile aus anderen Dokumenten hinzugenommen. Dabei haben wir auch immer wieder bestehende Passagen verbessert. Es sind neue Aspekte hinzugekommen. Diese haben wir in die aktuellen Dokumente eingebunden. Eigentlich müssten wir die bestehenden Dokumente entsprechend nachpflegen, damit diese neuen Aspekte in allen Dokumenten, die als potenzielle Vorlagen dienen könnten, enthalten sind. Dies ist allerdings zu aufwendig gewesen, um es konsistent umzusetzen. Da wir nicht konsequent mit denselben Vorlagen gearbeitet haben, enthalten einige Dokumente die Änderungen und einige nicht. So ist im Laufe der Zeit eine große Vielfalt entstanden.”
Dieses Szenario ist in vielen Technik-Redaktionen der Ausgangspunkt für die Entwicklung einer automatisierbaren Dokumentation. Einen Weg dorthin mit möglichst einfachen Mitteln – zumindest bis zur sinnvollen Einführung eines Redaktionssystems – wollen wir in diesem Beitrag skizzieren. Er beschreibt einige Ansätze, mit denen Sie Ihre Dokumentation für die Einführung eines Redaktionssystems vorbereiten können.
Dabei soll es nicht um konkrete Systeme oder Editoren gehen, sondern um inhaltliche und formale Aspekte der Dokumente selbst und um die Organisation. Denn saubere Arbeitsabläufe sind eine wesentliche Grundlage für eine mögliche Automatisierung.
Was ist Dokumentation?
In diesem Beitrag verwenden wir den Begriff Dokumentation für die Gesamtheit Ihrer Technik-Dokumente, von den verschiedenen Anleitungstypen über Risikobewertungen und CE-Kennzeichnungen bis hin zur Produktoberfläche.
Was ist ohne Redaktionssystem möglich?
Konkrete Redaktionssysteme, Automatisierungssysteme oder Editoren sind erst der zweite Schritt, denn alle Systeme haben eines gemeinsam: Die Daten, die sie verarbeiten, müssen maschinengerecht aufbereitet sein. Maschinengerecht bedeutet: Alle Vorgänge müssen Regeln folgen, die programmierbar sind. Jede Abweichung ist eine Ausnahme, die gesondert programmiert werden muss und die potenziell Konflikte mit anderen Ausnahmen verursacht.
Ein einfaches Beispiel hierfür können Dateinamen sein. Nehmen wir an, Sie übersetzen Ihre Dokumente in mehrere Sprachen. Wenn Sie für jede Sprache ein festes Kürzel definieren und festlegen, an welcher Stelle im Dateinamen es steht, kann eine Programmierung die Sprachversionen eines Dokuments automatisch erkennen und die Versionen einander zuordnen. Verwenden Sie uneinheitliche Namen oder Sprachbezeichnungen, ist das nur schwer möglich.
Auch die Abläufe sollten so weit standardisiert sein, dass die Dokumente immer auf die gleiche Weise erstellt werden können. Abweichungen von Standards bedeuten in einem automatisierten Umfeld immer manuelle Eingriffe, was wiederum einen negativen Effekt auf die Effizienz hat – auch schon vor der Einführung eines Redaktionssystems. Der große Vorteil der hier beschriebenen Aufbereitung Ihrer Dokumentationen: Bereits auf dem Weg stellen sich Verbesserungen ein, die die Arbeit erleichtern und Kosten sowie Aufwand senken.
Was ist eine optimierte Dokumentation?
Wir alle kennen das Prinzip KISS – Keep It Short and Simple – und wenden es an, um Dokumentationen leserfreundlich zu schreiben. Dieses Prinzip weiten wir auf die gesamte Dokumentation aus, um sie zu optimieren und effizient zu erstellen.
Bei der Erstellung von Technik-Dokumentationen verfolgen wir in der Regel zwei Ziele:
- Inhalte nutzergerecht aufzubereiten und
- die Dokumentation mit möglichst wenig Aufwand zu erstellen
Wege, um das erstgenannte Ziel zu erreichen, sind jedem Technik-Redakteur hinlänglich bekannt. Dabei geht es um Aufbau der Dokumente, Navigation, Auffindbarkeit der Information, Bildgestaltung – um nur einige Stichworte zu nennen.
Schauen wir also auf das zweite Ziel: die Dokumentation mit möglichst wenig Aufwand zu erstellen. Wie lassen sich Aspekte wie Workflow, Wiederverwendung, Übersetzung, Organisation der Informationen, Verwaltung sowie das Zusammenstellen und Verfassen neuer Dokumente so organisieren, dass der Aufwand sinkt und die Dokumentation schließlich automatisierbar wird?
Oft wird nicht konsistent dokumentiert
Wie erwähnt, finden sich viele Redakteure in dem eingangs beschriebenen Szenario wieder. Viele Redakteure kommen neu in ein Unternehmen, in dem es bisher noch keine Technik-Redaktion gab. Dabei muss dann mit einer vorhandenen Dokumentation gearbeitet werden, die nach und nach gewachsen ist. Unregelmäßigkeiten und individuelle Anpassungen sind hier eher die Regel als die Ausnahme.
Die hier dargestellten Möglichkeiten sind mithin keineswegs erschöpfend, denn jede Dokumentation ist individuell. Genauso individuell sind die Möglichkeiten zur Optimierung. Hier finden Sie einige Einstiegshilfen, auf denen Sie aufbauen können. Eine Anpassung an Ihre Gegebenheiten ist unerlässlich. Manchem Leser mögen einige Punkte als Selbstverständlichkeit erscheinen. Die tägliche Praxis zeigt aber, dass sehr selten konsistent nach festen Prinzipien gearbeitet wird.
So findet sich nach einer Befragung, die wir durchgeführt haben, jedes zweite Unternehmen zumindest teilweise in dem oben beschriebenen Szenario wieder. Deswegen stellen wir hier einige Aspekte dar, die einfach umzusetzen sind und mit denen Sie gemäß dem Pareto-Prinzip mit relativ wenig Aufwand eine nachhaltige Optimierung Ihrer Dokumentation erreichen können.
In der Regel ist die Technik-Dokumentation mit vielen Unternehmensprozessen verzahnt und übernimmt Arbeitsergebnisse aus anderen Unternehmensbereichen. Die hier gezeigten einfachen Regeln und Maßnahmen sind durchaus auch in anderen Unternehmensbereichen nachahmenswert. Damit stellen sie eine Möglichkeit dar, Expertenwissen aus der Technik-Redaktion in andere Unternehmensbereiche zu tragen, um dort die Arbeit zu erleichtern. Letztendlich wird es Ihnen als Technik-Redakteur zugutekommen, wenn die Arbeitsergebnisse, auf denen Sie aufbauen, eine bessere Qualität haben.
