Die TrainDOC-Umsetzung: hersteller- und plattformunabhängig
TrainDOC ist in Java realisiert. Somit kann es auf nahezu allen gängigen Betriebssystemen eingesetzt werden. Als Webserver wird der Apache Tomcat verwendet - die offizielle Referenzimplementierung für JSP und Java Servlets. Folglich sollte es keine Probleme mit anderen Java Application Servern geben, die in dieses Bereichen J2EE 1.4-konform sind.
Die Datenformate XML, XSL und HTML sind Open Standards (herstellerunabhängig) und werden von nahezu allen Softwareanbietern unterstützt. Somit kann auch zahlreichen anderen Programmen mit Hilfe dieser Formate Zugriff auf die Daten ermöglicht werden.
Die TrainDOC-Struktur: ...
... so einfach wie möglich
Gemäß dem Slogan "So einfach wie möglich" wurde TrainDOC realisiert als eine einfache serverbasierte Anwendung ähnlich den meisten Internet Homepages. Für dieses Konzeptes benötigt der Anwender lediglich einen Internet Browser - eine spezielle Client-Software und somit ein User-Helpdesk ist nicht erforderlich.
Da der größte Teil der technischen Dokumentation aus Text besteht, der in XML-Dateien abgelegt ist, ist eine Datenbank nicht erforderlich. Folglich wird auch kein Datenbankadministrator benötigt.
Nach der Installation von Java und Tomcat durch ein Set-Up Programm kann TrainDOC mit einem eigenen Installations-Script installiert werden. Nach der Konfiguration von TrainDOC (max. 10 Minuten) ist die Anwendung betriebsbereit. Im Normalfall muß der Systemadministrator nur noch den Anwendern mitteilen, mit welcher URL sie TrainDOC aufrufen müssen.
... so speziell wie nötig
Für die technische Dokumentation wurden spezielle XML-Formate definiert, die eine thematische Klassifizierung der einzelnen Textabschnitte ermöglicht. Somit wird trotz der unterschiedlichsten Dokumentstrukturen der einzelnen Zulieferer eine einheitliche Struktur für die gesamte Dokumentation geschaffen. Es ist dabei - bei Bedarf - unsere Aufgabe, die Dokumente für diese Struktur vorzubereiten. Und notfalls wird die Struktur angepaßt.
Die fortlaufende Verbesserung der Dokumentation: Kommentierung und Daten-Updates
Zu Beginn ist die technische Dokumentation nicht fehlerfrei oder vollkommen eindeutig. Da verschiedene Teile der Dokumentation von Mitarbeitern des Lieferanten geschrieben werden und diese nur ihre eigenen Komponenten beschreiben, sehen sie diese nicht im Kontext des Ganzen. Ihr Wartungspersonal hat aufgrund seiner Erfahrung das erforderliche Know-how, die Wartungsschritte im Kontext des Einbauortes zu sehen und zu beschreiben. Die Kommentarfunktion ist die Gelegenheit, den Autoren der Dokumentation eine Rückmeldung zu geben.
Während der Gewährleistung liegt die Verantwortung für die Qualität der Dokumentation beim Lieferanten. Somit ist es dessen Aufgabe, die Texte zu korrigieren und in die Daten der Installation zu integrieren. TrainDOC bietet dafür die erforderlichen Funktionen:
Die von den Anwendern angelegten Kommentare werden von einem TrainDOC-Administrator in einer Kommentardatei von der Anwendung heruntergeladen. Die entsprechenden Kommentare werden als "exportiert" markiert - eine Bearbeitung dieser Einträge ist jetzt nicht mehr möglich.
Der TrainDOC-Administrator sendet die Kommentardatei per Email an den Lieferanten.
Der Lieferant bearbeitet entsprechend die Texte und stellt die Änderungen zu einer Update-Datei zusammen.
Die Update-Datei wird vom Lieferanten wieder an den TrainDOC-Administrator gesendet, der diese über die Update-Funktion von TrainDOC installiert. Dabei werden alte Dateien archiviert, Antworten zu den Kommentaren hinzugefügt und entsprechende Meldungen im News-Bereich des Hauptmenüs eingetragen - automatisiert!
Dabei ist es ohne weiteres möglich, daß mehrere Kommentardateien "gleichzeitig" unterwegs sind.
