Die Funktionen von TrainDOC im Überblick

Navigation in den Dokumenten über funktionale und thematische Struktur

Die technische Dokumentation ist in den XML-Dateien gemäß den thematischen Blöcken innerhalb der Dokumente (technische Beschreibung, Wartungs- und Reparaturanleitungen sowie Fehlersuche) und der funktionalen Struktur des Zuges aufgeteilt. Die dadurch entstehenden Dokumentationsabschnitte erleichtern und beschleunigen das Auffinden der benötigten Informationen.

Diese Unterteilung spiegelt sich auch in den XML-Dateien wieder, die somit die Bearbeitung fehlerhafter Stellen mit dem integrierten XML-Editor erleichert.

Integration zusätzlicher Dokumente und Bilder in die technische Dokumentation

Da nicht jedes Dokument der Zulieferer in XML umgewandelt werden kann (oder darf), können selbstverständlich zusätzliche Dateien von der in XML vorliegenden technischen Dokumentation referenziert werden. Diese Dateien werden von TrainDOC in einem separaten Verzeichnis verwaltet.

Ersatzteilliste und Warenkorb

Die Liste der Ersatzteile des Systems kann mit TrainDOC verwaltet werden. Jeder Anwender kann die benötigten Ersatzteile in einen Warenkorb zusammenstellen und diesen dann von TrainDOC an eine konfigurierte Emailadresse - beispielsweise die des Einkaufs - versenden lassen. Der Anwender selbst benötigt für die Funktion am aktuellen Rechner kein Emailkonto! Die Einkaufsabteilung kann aufgrund der eingehenden Warenkörbe entscheiden, ob, wann und wieviel von den jeweiligen Ersatzteilen wo bestellt werden sollen.

Interaktive Navigation im bebilderten Ersatzteilkatalog

Die Bilder im Ersatzteilkatalog werden im SVG-Format dargestellt. Dadurch kann TrainDOC Ausschnittvergrößerungen und interaktive Verknüpfungen zwischen den einzelnen Positionen in den Bildern und den Positionslisten anbieten.

Für die Darstellung der Bilder wird lediglich der frei verfügbare SVG-Viewer von Adobe benötigt.

Volltextsuche in der technischen Beschreibung

Innerhalb der technischen Beschreibung können mit einer einfachen Volltextsuche Begriffe über die gesamte funktionale Struktur gesucht werden. Somit können leicht alle Stellen gefunden werden, in denen Aussagen zu einer speziellen Komponente oder Funktion gemacht werden.

Dynamische Erzeugung der Dokumentation als PDF

Die aktuelle Auswahl der Dokumentation kann dynamisch als PDF-Dokument generiert werden. Dieses Dokumente basieren stets auf den aktuellen XML-Dateien - werden aber aus einem Platten-Cache geladen, sofern das Dokument mit der angeforderten Konfiguration schon vorliegt.

Häufig angeforderte oder sehr große Dokumente können in einem Batch-Prozeß vorgeneriert werden.

Dynamische Erzeugung der tabellarischen Daten als CSV-Dateien

Analog zur PDF-Erzeugung können auch die Wartungspläne, Ersatzteillisten oder Baumstrukturen als CSV-Dateien erzeugt werden. Somit ist eine Weiterverarbeitung der Daten in einer Tabellenkalkulation problemlos möglich.

Kommentarfunktion

Die Kommentarfunktion ist eine kaum erkennbare aber sehr wichtige Funktion von TrainDOC. Zu Beginn ist die Dokumentation nicht fehlerfrei oder vollkommen eindeutig. Verschiedene Teile der Dokumentation wurden von Mitarbeitern des Lieferanten geschrieben und geben nur ihre eigenen Komponenten wieder; sie sehen sie nicht als Teil des kompletten Systems. Ihr Personal hat aufgrund seiner Erfahrung das erforderliche Wissen, die Wartungsschritte im Kontext zu sehen und zu beschreiben. Die Kommentarfunktion ist die Gelegenheit, den Autoren der Dokumentation eine Rückmeldung zu geben.

Die Kommentare werden nicht in der Dokumentation gespeichert, sondern über Positionsmarken mit den Dokumenten verknüpft. Diese Positionsmarken sind eindeutig und über die gesamte technische Dokumentation verteilt. Jeder Anwender kann Kommentare anlegen bzw. seine Kommentare bearbeiten oder wieder löschen. Jede Änderung an den Zuständen der Kommentare wird von der Anwendung protokolliert.

Eine Kommentarübersicht stellt separat alle Kommentare und eventuelle Stellungnahmen der Bearbeiter der Dokumentation dar. Ein allgemeiner Überblick über mögliche Veränderungen in der Dokumentation steht somit jedem Anwender zur Verfügung.

Die Kommentarliste ist kann als "Korrekturliste der Dokumentation" interpretiert werden und während der Gewährleistung oder bei Beauftragung als Grundlage für ein Daten-Update verwendet werden. Für eine selbständige Korrektur der Dokumentation steht der integrierte XML-Editor zur Verfügung.

Datenaktualisierung und -backup

Die Einleitung einer Datenaktualisierung sowie das Einspielen eines Datenupdates wird ausschließlich über die Programmoberfläche durchgeführt. Beim Installieren eines Updates werden alle veralteten Dateien in einer Archivdatei gesichert. Je nach Umfang des Updates können die Anwender ohne Unterbrechung weiterarbeiten.

Verbunden mit dieser Funktion ist ein Konzept, das die fortlaufende Verbesserung der Dokumentation zum Ziel hat.

Integrierter XML-Editor

Für kleinere Änderungen an der technischen Dokumentation stellt TrainDOC einen integrierten XML-Editor zur Verfügung. Die Integration des Editors in das System gewährleistet, daß die Änderungen am Dokument protokolliert werden und die alte Version der bearbeiteten Datei als Backup gesichert wird.

Sind für die XML-Datei Kommentare vorhanden, können diese hier behandelt und auch beantwortet werden.

Eine in der Bearbeitung befindliche Datei wird nur als Arbeitskopie gespeichert. Erst nach einer Freischaltung werden die Änderungen in die offizielle Dokumentation übernommen - bis dahin sehen alle Anwender nur die bisherige freigegebene alte Dateiversion.

Mehrsprachig

Nicht nur TrainDOC selbst ist mehrsprachig, sondern es ist auch in der Lage, die technische Dokumentation in Abhängigkeit von der Sprachauswahl des Anwenders anzuzeigen. Um die Texte in den verschiedenen Sprache bei den Änderungen synchron zu halten, werden alle Sprachversionen eines Textes in einer Datei gehalten. Ist die ausgewählte Sprache nicht vorhanden, wird die Dokumentation von TrainDOC in einer Ersatzsprache angezeigt. Somit erhält der Anwender die gewünschte Information (und wird zusätzlich darüber in Kenntnis gesetzt, daß ein Teil der Dokumentation noch übersetzt werden muß).

Verwaltung mehrerer technischer Dokumentationen

TrainDOC bietet die Möglichkeit, die Dokumentationen mehrerer Systeme zu verwalten. Die verschiedenen Projekte sind in der Anwendung wie auch in der Datenhaltung präzise voneinander getrennt, um Verwechslungen oder Vermischungen der Dokumentationen der einzelnen Systeme zu vermeiden.

Integrierte Benutzerverwaltung und Rechtevergabe

TrainDOC verwaltet seine Anwender selbst und stellt drei verschiedene Rechtegruppen zur Verfügung:

• Administratoren sind normale Anwender, die andere Anwender in TrainDOC einrichten oder löschen können. Ferner stehen ihnen die Update- und Konfigurationsfunktionen zur Verfügung. Es sind jedoch keinerlei Systemadministrationsrechte erforderlich.

• Editoren sind Anwender, die Dokumente mit dem XML-Editor bearbeiten und Kommentare anderer Anwender ergänzen oder löschen dürfen.
• Mit Leserechten ausgestattete Anwender dürfen die Dokumentation einsehen, Kommentare und Warenkörbe anlegen.

Grundsätzlich ist dieses Berechtigungskonzept so einfach wie möglich gehalten: es gibt keine Superadministratoren, es wird nicht danach gefragt, welcher Administrator welchen Anwender angelegt hat, etc.

Einfache Konfiguration

Die Konfiguration von TrainDOC wird ausschließlich über Browserdialoge vorgenommen. Abgesehen von der Installation der Anwendung ist für die TrainDOC-Administratoren kein direkter Zugriff auf den Server erforderlich.