Eclipse

(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)

DITA ist vor allem ein Dokumentationsstandard für die Software-Dokumentation. Daher liegt es nahe, nach Werkzeugen für DITA zu suchen, die im Bereich der Software-Entwicklung angesiedelt sind. Eclipse, ein Open-Source-Framework zur Entwicklung von Software, das ursprünglich von IBM entwickelt wurde, gehört in diesem Bereich sicherlich zu den beliebtesten und am häufigsten verwendeten Entwicklungsumgebungen.

Eclipse ist mit Java programmiert und stellt eine Plugin-Architektur zur Verfügung. Über Plugins lässt sich praktisch alles in Eclipse integrieren, was zur Programmierung von Software und deren Dokumentation notwendig ist. So stehen als Plugin für Eclipse zahlreiche XML-Editoren zur Verfügung wie zum Beispiel XMLBuddy oder der WTP XML Editor.

Doch bieten die XML-Editoren nicht den vergleichbaren Komfort, den reine XML-Editoren bieten. Zum Beispiel wird man eine Rechtschreibprüfung vergeblich in einem XML-Editor in Eclipse suchen. Auch der conref-Mechanismus wird bei den jetzigen XML-Editoren in Eclipse nicht direkt unterstützt.

Abbildung: Der XML-Editor XMLBuddy in Eclipse mit einem Topictyp „Konzept“.

Der fehlende Komfort bei den XML-Editoren wird ausgeglichen durch die Bereitstellung einer kompletten Umgebung zur Verwaltung der Dateien und die Möglichkeit, die Produktion von Ausgabemedien zu automatisieren.

In Eclipse integriert ist die Anbindung an Systeme zur Versionsverwaltung, wie Concurrent Versions System (CVS) oder Subversion (SVN). Gerade in der Software-Entwicklung, in der Teams an der Software arbeiten, erweist sich eine solche Anbindung als sehr nützlich. Der Zugriff ist auf die zentral abgelegten Dateien möglich, wobei kontrolliert wird, wer die Dateien bearbeitet. Auch für die Erstellung der Dokumentation erweist sich diese Konstellation als sehr nützlich.

Die Verwendung von ANT Build-Dateien ist in Eclipse eine Selbstverständlichkeit. Über ANT Build-Dateien wird in Eclipse die Erstellung der Software-Programme aus dem Java-Quellcode gesteuert. Auch die Verwendung der ANT Build-Dateien von DITA ist möglich, um aus den in Eclipse erstellten DITA XML-Dateien Ausgabemedien wie HTML oder PDF erzeugen zu können.

Für die XSLT-Transformationen können Sie das „Orangevolt EclipseXSLT“-Plugin verwenden. Hier können Sie auf die XSLT-Stylesheets des DITA Open Toolkits zurückgreifen.

Für die Integration des XSL-FO-Formatieres Apache FOP steht das „FOP bridge“-Plugin von Ahmadsoft zur Verfügung.

Somit lässt sich mit den Komponenten

• SVN-Anbindung,
• XMLBuddy-Plugin,
• Orangevolt EclipseXSLT-Plugin,
• FOP bridge-Plugin

ein Bereich innerhalb einer Software-Entwicklungsumgebung schaffen, in der die Dokumentation für die Software erstellt werden kann. Zwar mögen die Möglichkeiten in den zur Verfügung stehenden XML-Editoren nicht den höchsten Ansprüchen einer Bearbeitung von XML-Dateien genügen, dennoch ist der Technische Redakteur mit Eclipse nahe an der Produktentwicklung dran.

Neben der Möglichkeit, in Eclipse Dokumentationen mit DITA erstellen zu können, bietet sich Eclipse auch als Werkzeug zur Strukturierung von Handlungen an, die ein Nutzer durchführen muss, um beispielsweise ein Software-Programm korrekt bedienen zu können. Dazu wird für Eclipse der IBM DITA Task Modeler angeboten.

Geht man davon aus, dass die Handlungen bei der Bedienung eines Produkts zielorientiert sind, kann eine Hierarchie von einzelnen Aufgaben bestimmt werden, bis die Bedienung des Produkts abgeschlossen ist. Den IBM DITA Task Modeler können Sie dazu nutzen, die Hierarchie der möglichen Ausgaben zu modellieren.

Abbildung: Der IBM DITA Task Modeler zum Modellierung einer Aufgabenhierarchie.

Vom Konzept her ähnelt es dem Storyboard, wie es bei der Strukturierungsmethode STOP angewendet wird. Informationen zu STOP finden Sie unter "STOP".

Um die am Reißbrett entworfene Hierarchie der Aufgaben für die Praxis nutzen zu können, steht Ihnen im IBM DITA Task Modeler ein DITA Map-Editor zur Verfügung. Ergänzt wird der Map-Editor durch einen weiteren Editor, in dem Sie Beziehungstabellen für die Topics erstellen können.

Der IBM DITA Task Modeler ist ein sehr mächtiges Werkzeug, dessen Verwendung sich besonders bei komplexen Projekten eignet, an dem ein oder mehrere Teams arbeiten.

Somit bieten Eclipse und der IBM DITA Task Modeler eine integrierte Umgebung, deren Anwendung vor allem im Bereich der Software-Entwicklung liegt.

  

<< zurück

vor >>