Engine control system document generation

Abstract

Large scale documentations offer options for document generation if built and maintained well. The purpose of this work is to analyse the benefits of using modular documentation and how the generation process of a certain document could be automated with it. System is designed for a marine company on how an engine control system document for classification societies could be generated. Modular documentation and classification societies are introduced which helps to understand how the new document could be structured. As results the structure of the new document, required modifications to documentation and guidelines on how to proceed are produced. In conclusion the effects of implementing the proposed design to the current documentations and the main benefits of it are briefly explained.

Ison skaalan dokumentaatiot antavat mahdollisuuksia dokumenttien generointiin hyvin rakennettuna ja huollettuna. Tämän työn tarkoituksena on analysoida modulaarisen dokumentaation hyötyjä ja kuinka generointiprosessi tietylle dokumentille voisi automatisoida. Systeemi suunnitellaan laivan moottoreita valmistavalle yritykselle kuinka moottorinohjausjärjestelmän dokumentti luokituslaitoksille voidaan generoida. Modulaarinen dokumentointi sekä luokituslaitokset esitellään mikä auttaa ymmärtämään kuinka uusi dokumentti voidaan rakentaa. Tuloksena saadaan tietoa uuden dokumentin rakenteesta, dokumentaation muutoksista ja ohjeet kuinka edetä. Yhteenvetona käydään läpi kuinka uuden systeemin implementointi vaikuttaa dokumentointiin sekä sen tärkeimmät hyödyt.