Technische Dokumentation für den Maschinenbau

Hightech-Maschinen werden immer leistungsfähiger und komplexer. Die technische Dokumentation dazu wird umfangreicher und muss selbstverständlich den rechtlichen und landesspezifischen Ansprüchen genügen. Unternehmen können bei der Erstellung der Dokumentation mit den typischen Informationstypen wie Handlungsanweisungen, Fehlerdiagnose, Sicherheitshinweise oder Fehlersuchbäume auf geeignete Redaktionssysteme mit z.B. einer DITA‑Spezialisierung bauen. Das Redaktionssystem von Noxum unterstützt die Informations­modellierung und Spezialisierung in DITA.

Würzburg, 03. August 2012 - Die Noxum GmbH, Spezialist für Content Management und Redaktionssysteme, unterstützt Unternehmen aus dem Maschinen- und Anlagenbau in ihrer technischen Dokumentation mit dem Noxum Publishing Studio. Insbesondere die Topic‑basierte Arbeitsweise des Noxum Publishing Studio ermöglicht die Informationsmodellierung und Spezialisierung nach der ebenfalls Topic-orientierten Strukturierungsmethode DITA.

Typische Szenarien im Maschinenbau

Unternehmen im Bereich Maschinenbau erstellen häufig mehrere hundert oder gar tausend Betriebsanleitungen - an verschiedenen Standorten und in unterschiedlichen Sprachen. Aus mehreren Quellsprachen werden die Dokumente in möglicherweise bis zu 30 Zielsprachen übersetzt. Es kann schnell zu redundanten Inhalten und damit unnötigen Herstellungs- und Übersetzungskosten kommen, sowie zu Inkonsistenzen und damit verbundenen Qualitätsverlusten. Um dies zu vermeiden, liegt die Aufgabenstellung und gleichzeitig die Herausforderung für die Technische Dokumentation in der Erstellung wiederverwendbarer, kontextunabhängiger Inhaltsbausteine, auf Basis einer unternehmensspezifischen Informationsarchitektur.

Topic-Ansatz im DITA-Konzept

Die Praxis zeigt, dass sich gerade für diese Anforderung die Strukturierungsmethode DITA bewährt. Gegenüber anderen Informationsarchitekturen mit unflexiblen Buch-, Kapitel- und Abschnittsstrukturen liegen die Vorteile von DITA in dem flexiblen Topic-Ansatz. Dieser sorgt dafür, dass Topics erst bei der Verbauung hierarchisiert werden. Somit müssen Inhalte nur einmal erstellt werden und können dann immer wieder an unterschiedlichen Stellen verbaut werden. Die Informationseinheiten nach dem DITA‑Topic‑Ansatz bieten somit eine flexible Mehrfachverwertung einmal geschriebener und ggf. bereits in andere Zielsprachen übersetzter Informationseinheiten. Daraus ergibt sich eine Reduzierung des zu erstellenden und zu pflegenden Dokumentationsumfangs. Sollten in unterschiedlichen Fachbereichen dennoch spezielle Topic-Typen erforderlich sein, bietet das DITA-Konzept die Möglichkeit der Spezialisierung. Durch die Ableitung von Basis-Topics können so rasch abteilungsspezifische Objekttypen erstellt und verwendet werden.

Geführte Erstellung mit dem Noxum Publishing Studio

Für die Erstellung von ergänzenden Elementen der Bedienungsanleitungen, wie z.B. Wartungspläne, Störungstabellen oder Sicherheitshinweise, kann der Redakteur entsprechende Topic-Templates auswählen. Zum Anlegen der Objekte steht ein Wizard zur Verfügung: Dieser Objekterstellungs-Wizard führt den Redakteur in einem Dialog, der ihm eine Auswahlliste gemäß der Klassifizierungsebenen bietet. Durch die Auswahl einer Klassifizierung kann das Objekt entsprechenden Typs aus einem definierten Template erzeugt werden. Diese Arbeitsweise gewährleistet eine strenge Qualifizierung der Inhaltsbausteine und auch hier einen hohen Wiederverwendungsgrad.

Beschreibende Schemainformationen zur Verwendung der Objekte und Elemente stehen dem Redakteur direkt im XML‑Editor visuell zur Verfügung. Der entsprechende Redaktionsleitfaden dazu kann kontextsensitiv im XML‑Editor eingebunden werden. Relevante Passagen kann der Redakteur über Links aus den Schemainformationen aufrufen.

Automatische Prozesse

Die XML-Basierung von DITA bietet die Verarbeitung für unterschiedliche Distributionsformen und -medien durch Automatisierung in gesicherter Qualität und ermöglicht Zeit- und Kosteneinsparungen. Dazu werden typische Bestandteile technischer Schriften wie Inhaltsverzeichnisse - Dokumentweit oder Kapitelweise -, Abbildungsverzeichnisse oder Stichwortverzeichnisse automatisch generiert.

Bei der automatischen Publikation in verschiedene Formate wie z.B. PDF, Web, Word oder HTML Help wird der Redakteur durch eine nahezu Layout-verbindliche Preview-Funktion unterstützt. Dabei stehen mehrere Dokumenten-Layouts zur Verfügung. Eine Publikation z.B. als PDF kann mit der Noxum Publishing Technology umgesetzt und zu 100% automatisiert werden.

Maschinenbau-Projekte mit Noxum

Die einzelnen Projektphasen zur Implementierung des Redaktionssystems und einer DITA‑Spezialisierung werden von Noxum mit Workshops begleitet. Das Ziel dabei ist, die Funktionen des Noxum Publishing Studio in idealer Weise für die aktuellen Redaktionsanforderungen der Unternehmen verfügbar zu machen. Mit dem XML-basierten Redaktionssystem von Noxum und einer DITA‑Spezialisierung können die Redaktionen die geforderten Mengengerüste bewältigen und die Publikationen in der geforderten Qualität für alle Zielsprachen erstellen. Über die Ergebnisse jahrelanger Zusammenarbeit mit den Unternehmenskunden geben Referenzen von Noxum Zeugnis.