Funktionerna i TrainDOC – en översikt

Navigering bland dokumenten enligt funktionell och tematisk struktur

Den tekniska dokumentationen i XML-filerna är indelad enligt tematiska dokumentationsblock (teknisk beskrivning, underhålls- och reparationsinstruktioner samt felsökningsinstruktioner) och enligt tågets funktionella struktur. De motsvarande dokumentationsavsnitten gör att det går lätt och snabbt att hitta den information som behövs.

Denna indelning avspeglas också i XML-filerna, och gör det enkelt att bearbeta felaktiga avsnitt med den inbyggda XML-redigeraren.

Integration av tilläggsdokument och bilder i den tekniska dokumentationen

Eftersom inte alla dokument från underleverantörer kan (eller får) omvandlas till XML-format, går det givetvis att referera till dessa tilläggsfiler från den tekniska XML-dokumentationen. Dessa filer lagras av TrainDoc i en separat lista.

Reservdelslista och varukorg

Reservdelslistan för systemet kan administreras med TrainDOC. Alla användare kan lägga de reservdelar som behövs i en varukorg och låta TrainDOC skicka denna till en konfigurerad e-postadress, t.ex. till inköpsavdelningen. Användaren behöver inte ens ha något e-postkonto på den aktuella datorn. Inköpsavdelningen kan, baserat på inkommande varukorgar, avgöra om och när och i vilket antal respektive reservdel ska beställas.

Interaktiv navigering i illustrerad reservdelskatalog

Bilderna i reservdelskatalogen är framställda i SVG-format. Därigenom kan TrainDOC erbjuda delförstoringar och interaktiva kopplingar mellan enskilda positioner i bilderna och positionslistorna.

För visning av bilderna används enbart det kostnadsfria programmet SVG-Viewer från Adobe.

Fritextsökning i tekniska beskrivningar

Inom de tekniska beskrivningarna går det att söka efter begrepp (i hela funktionsstrukturen) med en enkel fritextsökning. På så sätt går det lätt att hitta alla ställen, där en speciell komponent eller funktion omnämns.

Dynamisk framställning av dokument i PDF-format

Det aktuella urvalet dokument kan dynamiskt konverteras till PDF-format. Dessa dokument baseras helt på de aktuella XML-filerna, men lagras på diskcache, om dokumentet med begärd konfiguration finns.

Dokument som används ofta eller är mycket stora kan skapas på förhand i en batchprocess.

Dynamisk framställning av tabelldata som CSV-filer

På motsvarande sätt som för framställningen av PDF-filer går det också att skapa underhållsplaner, reservdelslistor eller trädstrukturer i form av CSV-filer. Därmed går det enkelt att vidarebearbeta data i ett kalkylbladsprogram.

Kommentarsfunktion

Att kunna skriva kommentarer är en mycket viktig funktion i TrainDOC (även om den inte syns så mycket). Från början är dokumentationen varken helt felfri eller helt entydig. Olika delar av dokumentationen har skrivits av medarbetare hos underleverantörer och återger normalt endast funktionen hos de egna komponenterna; inte deras funktion som delar i det fullständiga systemet. Er personal har på grund av sin erfarenhet den kunskap som behövs för att kunna se och beskriva underhållsstegen i sitt sammanhang. Med kommentarsfunktionen kan man ge återkoppling till dokumentens författare.

Kommentarerna sparas inte i dokumenten, utan kopplas ihop med dokumenten via positionsmarkeringar. Dessa positionsmarkeringar är entydiga och fördelade över den samlade tekniska dokumentationen. Varje användare kan lägga in kommentarer och sedan bearbeta eller ta bort dem. Varje ändring i kommentarernas status registreras av programmet.

I en kommentaröversikt visas alla kommentarer samt eventuella åtgärder från den som bearbetat dokumentationen. Det finns också för alla användare en allmän översikt över möjliga förändringar i dokumentationen.

Kommentarlistan kan tolkas som en "ändringslista" för dokumentationen och användas som grund för datauppdatering under garantitiden eller vid senare ändringsuppdrag. För direkt korrigering av dokument finns den inbyggda XML-redigeraren.

Datauppdatering och säkerhetskopiering

Uppdateringen av data liksom installationen av en uppdatering sker helt och hållet via programmets gränssnitt. Vid installationen av en uppdatering sparas alla föråldrade filer i en arkivfil. Beroende på uppdateringens omfattning kan användaren arbeta vidare utan avbrott.

Till den här funktionen hör en annan, som till mål har att fortlöpande förbättra dokumentationen.

Inbyggd XML-redigerare

För mindre ändringar i den tekniska dokumentationen finns det en inbyggd XML-redigerare i TrainDOC. Att redigeraren är inbyggd i systemet garanterar att ändringarna i dokumenten protokollförs och att en säkerhetskopia sparas av den gamla versionen av den bearbetade filen.

Om det finns kommentarer i XML-filen, kan dessa behandlas här och även besvaras.

En fil som håller på att bearbetas sparas enbart som arbetskopia. Först efter en publicering visas ändringarna i den officiella dokumentationen – innan dess användarna enbart den dittills publicerade versionen av filen.

Flerspråkig

TrainDOC är inte enbart flerspråkig, utan är utformat så att den tekniska dokumentationen visas i enlighet med användarens språkval. För att texterna på de olika språken ska vara parallella (överensstämmande), sparas alla språkversioner av text i en och samma fil. Om det aktuella språket inte är tillgängligt, visas dokumentationen i TrainDOC på ett ersättningsspråk. På så sätt får användaren den önskade informationen (och får dessutom reda på att en viss del av dokumentationen måste översättas).

Hantering av flera uppsättningar teknisk dokumentation

TrainDOC ger möjlighet att hantera dokumentation för flera olika system. De olika projekten är helt separerade från varandra, både för användarna och när det gäller datalagringen. Därmed undviks förväxlingar eller sammanblandning av dokumentation för de olika systemen.

Integrerad användar- och behörighetsadministration

Användarna hanteras helt i TrainDOC, som erbjuder tre olika behörighetsgrupper:

• Administratörer är vanliga användare, som kan lägga till och ta bort andra användare i TrainDOC. Dessutom kan de använda uppdaterings- och konfigureringsfunktionerna. De behöver inte ha behörighet som systemadministratör för den lokala datorn eller servern.

• Redaktörer är användare som kan bearbeta dokument med XML-redigeraren och som får bearbeta eller ta bort kommentarer från andra användare.
• Användare med läsbehörighet ("Läsare") kan visa dokument samt skapa kommentarer och varukorgar.

Denna behörighetsmodell har medvetet gjorts så enkel som möjligt: Det finns inga huvudadministratörer, ingen efterfrågar vilken administratör som skapat vilken användare o.s.v.

Enkel konfiguration

Konfigurationen av TrainDOC utförs enbart via webben. Förutom vid installationen av programmet behöver TrainDOC-administratörerna inte ha någon direkt åtkomst till servern.