TrainDOC-egenskap: tillverkar- och plattformsoberoende
TrainDOC är programmerat i Java. Därför kan det användas i nästan alla typer av datorer. Som webbserver används Apache Tomcat – den officiella referensimplementeringen för JSP och Java Servlets. Därmed bör det inte vara några problem med andra typer av Java Application Server, som är J2EE 1.4-kompatibla.
Dataformaten XML, XSL och HTML är öppna standarder (tillverkaroberoende) och stöds av nästan alla programvaruleverantörer. Därför går det att arbeta med data även i många andra program.
TrainDOC:s struktur: ...
... så enkel som möjligt
Enligt mottot "Så enkelt som möjligt" har TrainDOC utformats som ett enkelt serverbaserat program, på ett liknande sätt som de flesta webbplatser. För detta behöver användaren enbart en webbläsare: Inget speciell klientprogram med tillhörande supportfunktion/helpdesk krävs.
Eftersom största delen av den tekniska dokumentationen är text i XML-filer, behövs heller ingen databas. Därför behövs inte heller någon databasadministratör.
Efter installation av Java och Tomcat med hjälp av ett installationsprogram kan TrainDOC installeras med ett eget installationsskript. Efter konfigurering av TrainDOC (max. 10 minuter) är programmet klart att användas. I normalfallet måste systemadministratören sedan bara meddela användarna på vilken webbadress de kan nå TrainDOC.
... så speciell som krävs
För den tekniska dokumentationen har ett antal speciella XML-format definierats, som möjliggör en tematisk klassificering av enskilda textavsnitt. På det sättet har en enhetlig struktur kunnat skapas för den samlade dokumentationen, trots varierande struktur för dokument från olika underleverantörer. Därvid är det – när det behövs – vår uppgift att förbereda dokumenten för denna struktur. I nödfall anpassas även strukturen.
Fortlöpande förbättring av dokumentationen: Kommentarer och datauppdatering
Från början är den tekniska dokumentationen varken helt felfri eller helt entydig. Eftersom olika delar av dokumentationen har skrivits av medarbetare hos olika underleverantörer, beskrivs där normalt endast funktionen hos de egna komponenterna, inte deras funktion i ett större sammanhang. Er underhållspersonal har, på grund av sin erfarenhet, den kunskap som behövs för att se och beskriva underhållsstegen med hänsyn till apparatplaceringen. Med kommentarsfunktionen kan man ge återkoppling till dokumentens författare.
Under garantitiden ligger kvalitetsansvaret hos leverantören. Därvid är det leverantörens uppgift att rätta texterna och integrera dem i installationen. TrainDOC innehåller de funktioner som behövs för detta:
De kommentarer som lagts in av användarna samlas av TrainDOC-administratören i en kommentarsfil i programmet. Motsvarande kommentarer markeras som "exporterade" och någon vidare bearbetning av dessa kommentarer är sedan inte möjlig.
TrainDOC-administratören skickar kommentarsfilen till leverantören per e-post.
Leverantören bearbetar de berörda texterna och sammanställer ändringarna i en uppdateringsfil.
Uppdateringsfilen skickas av leverantören till TrainDOC-administratören, som sedan installerar de rättade dokumenten med hjälp av uppdateringsfunktionen i TrainDOC. Då arkiveras även äldre versioner av filerna, svar på kommentarerna bifogas och motsvarande meddelanden skapas i nyhetsfältet på huvudmenyn – automatiskt!
Under den här processen går det utan problem att ha flera kommentarsfiler "samtidigt" på väg.
