Unsere Technische Redakteurin Anna Numberger unterstützt seit zwei Jahren das Dokumentationsteam unseres Kunden im Bereich Offshore-Windkraftanlagen.
Ihre Hauptaufgaben sind die Erstellung von Arbeitsanweisungen und Wartungschecklisten mit dem Redaktionssystem Cinnamon CDCplus.
Wie funktioniert Cinnamon CDCplus?
Ähnlich wie bei MadCap Flare werden einzelne Textmodule in einem übergeordneten Dokument zusammengefügt. Auch hier hat man also den Vorteil von aufgesplitteten Elementen, die unterschiedlich kombiniert werden können.
„Regelmäßig benötigte Bausteine, wie z.B. Einleitungssätze und Warnhinweise, muss ich nur einmal erstellen und kann sie dann für andere Projekte wiederverwenden”, sagt Anna. „Zur Texterstellung nutze ich den XML-Editor Oxygen, der sich intuitiv bedienen lässt.”
Die Formatierung ist dann zwar wie bei MadCap Flare unabhängig vom Inhalt und wird über das Zuweisen von XML-Tags definiert, jedoch gibt es einen Unterschied:
„Ich kann die Eigenschaften der einzelnen XML-Tags nicht frei konfigurieren”, erklärt Anna. „Es gibt eine festgelegte Struktur in der Formatierung, an die jeder Redakteur gebunden ist”.
Für Formate wie beispielsweise Tabellen, die sich nur durch die Inhalte unterscheiden, gibt es Templates.
„Das sind leere Vorlagen mit festgelegten Eigenschaften, die z.B. bei Tabellen die Breite und Höhe der Zellen bestimmen. Diese kann ich einfach rauskopieren und entsprechend befüllen, ohne mir Gedanken über die Formatierung machen zu müssen.”
Mit Cinnamon CDCplus können Sie Textbausteine modular verwenden
Weitere Vorteile sind noch die automatische Erstellung der Titelseite, der Copyright-Hinweise auf jeder Seite und der Header, damit alles einheitlich aussieht.
Die Zusammenarbeit im Team ist durch die gebündelte Verwaltung der Daten ebenfalls erleichtert, da so jeder Mitarbeiter Zugriff hat. Wenn das Dokument freigegeben ist, wird beim erneuten Ändern automatisch eine neue Version erstellt. So wird sichergestellt, dass keine Daten ausversehen überschrieben werden.
Nachvollziehbarkeit als wichtiges Element
Sehr wichtig ist die übersichtliche Revisionshistorie. Hier kann jeder nachvollziehen, wer wann was am Dokument geändert hat. Auch ältere Versionen sind jederzeit wiederverwendbar.
Das kann bei aufkommenden Schäden am Endprodukt wichtig werden, um z. B. den Stand vom Zeitpunkt der letzten Wartung zu prüfen. Gab es einen Fehler in der Wartungsanleitung, aufgrund dessen etwas falsch verbaut wurde?
Ein Redaktionssystem wie Cinnamon CDCplus hat also durchaus Sinn, wenn Dokumente oft angepasst werden und lange Änderungshistorien haben. Werden dagegen hauptsächlich kurze Anleitungen erstellt, die für Jahre gleich bleiben, lohnt es sich weniger.
MadCap Flare kann die verschiedensten Formate ausgeben
Welchen Nachteil hat die Software?
„Manche Prozesse sind umständlich”, findet Anna. Während Saskia z. B. die Bilder bei MadCap Flare nur in den Text zieht und die richtige Ablage automatisch passiert, muss Anna die Bilder zuerst manuell in das entsprechende Verzeichnis laden. Erst danach kann sie das Bild als Link bzw. Querverweis in ihren Text einfügen.
„Das ist sehr aufwändig, da ich das richtige Bild immer erst aus der Ordnerstruktur raussuchen muss. Außerdem führt das bei großen Dokumenten mit vielen Bildern zu einer unübersichtlichen Darstellung, da nur die Links angezeigt werden.”
Wie Sie sehen, muss vor der Anschaffung eines Redaktionssystems genau geschaut werden, welche Anforderungen gestellt werden. Wird danach die passende Software ausgesucht, kann sich die Einführung je nach Einsatzzweck durchaus lohnen.
Ab nächster Woche beschäftigen wir uns mit dem Thema Sondermaschinenbau und geben Ihnen interessante Einblicke in die notwendige Dokumentation.
