Redaktionssysteme

Eigenentwicklung DART

Wegen der heutigen Variantenvielfalt der Produkte und der damit verbundenen, geschilderten Aufgaben an die Dokumentation (SGML/XML-Dokumentationen) haben wir intern eigens das Redaktionssystem DART entwickelt. DARTsteht für Datenpoolbasiertes Adapatives RedaktionsTool.

Komponenten

Bei der Entwicklung von DART haben wir das Rad nicht auf allen Gebieten „neu erfunden“, sondern setzen, wo möglich und sinnvoll, etablierte Softwarekomponenten ein.

• Das Layout für die papiergebundene Ausgabe (PDF) erstellen wir mit FrameMaker+SGML.
• Zur Versionierung setzen wir subversion ein. Dieses Versionsmanagementsystem wird zur Ablage textbasierter Dateiformate (i.d.R. Programm-Quellcode) bereits seit längerer Zeit erfolgreich eingesetzt.
• Zur effizienten Erstellung von Übersetzungen nutzen wir das Translation Memory System déjàvu.

Neben diesen „Eckpfeilern“ bilden von uns erstellte Hilfprogramme das Gerüst unseres Redaktionssystems. Die Hilfsprogramme verarbeiten die Ausgabe des Standard-Parsers nsgmls und werten so die Zusatzinformationen aus den SGML-Quelltexten aus. Zum Beispiel wird so eine Umwandlung in Dokumentinstanzen gemäß einer layout-basierten DTD durchgeführt. Durch diesen zweistufigen Ausgabeprozess können wir die Quelltexte tatsächlich unabhängig von der später geplanten Ausgabe und dem hierzu notwendigen Programm (bei uns: FrameMaker) erstellen. So wird z.B. ein Hinweis nicht als Tabelle mit Icon u.ä. in SGML erstellt, sondern die Umwandlung in diese Form erfolgt erst bei der o.g. späteren Umsetzung. Hierdurch reduzieren sich die Quelltexte in der Struktur auf das Wesentliche, entsprechend schnell kann eine Ausgabe realisiert werden.

Der Einsatz von FrameMaker+SGML erlaubt unseren Kunden, kleinere Anpassungen in den FrameMaker-Dokumenten selbst direkt und schnell durchzuführen, falls sie dies wünschen (z.B. um kurzfristig vor Ort einen neu hinzugekommenen Parameter in der Steuerung in die Dokumentation aufzunehmen). Außerdem bleibt unseren Kunden somit jederzeit die Möglichkeit, den Schritt zurück zur konventionellen Dokumentation (Standard-Dokumentationen) zu gehen, falls dies z.B. wegen geänderter Rahmenbedingungen einmal nötig werden sollte.

Datenpool

Alle Dokumente liegen im Quellformat SGML bzw. XML in einem Datenpool. Dieser Datenpool wird mit dem Versionskontrollsystem subversion verwaltet, so dass jederzeit Zugriff auf beliebige Versionsstände möglich ist.

Neben der Erzeugung von maschinentypspezifischen Dokumentationen können über den gleichen Mechanismus z.B. auch zielgruppenspezifische Dokumentationen erstellt werden.

Status-Quo-Modul

Damit Sie jederzeit einen Überblick über den aktuellen Stand Ihrer Dokumentationen haben, ist in DART ein „Staus-Quo-Modul“ integriert. Hier erkennen Sie jederzeit auf einen Blick, welchen Stand die einzelnen Dokumentationen in den verschiedenen Sprachen haben. Über Verknüpfungen können aus diesem Modul heraus direkt die einzelnen Dokumentationen angezeigt und ggf. ausgedruckt werden.

Fazit

Das von uns entwickelte System zielt insbesondere auf den Mittelstand ab, da am Markt etablierte Systeme recht hochpreisig sind und ihre Einführung in den Unternehmen oftmals sehr starke Umstrukturierungen in der Dokumentationsabteilung nach sich zieht. Auch andere Abteilungen, die ebenfalls in den Dokumentationsprozess eingebunden sind (z.B. die Konstruktionsabteilung durch das Bereitstellen von Stücklisten), können hiervon betroffen sein. Solche Umstrukturierungen sind jedoch insbesondere bei einer starken Kundenausrichtung und der damit verbundenen, notwendigen Flexibilität aus unserer Erfahrung nur sehr schwer umzusetzen.