Dokumenttipohjan luominen

Abstract

Tämän opinnäytetyön tavoitteena oli luoda yritykselle dokumenttipohja, joka helpottaisi käyttöohjeiden tekoa yrityksen tuotteille ja samalla tuotteiden komponentteihin liittyvän tiedonhakua, koska tiedot kootaan yhteen paikkaan. Tarkoituksena oli luoda yleispätevä pohja, jota voidaan soveltaa yrityksen kaikkiin tuotteisiin. Näin saadaan käyttöohje, joka noudattaa samaa kaavaa ja on jokaisen tuotteen kohdalla yhteneväinen. Lisäksi tavoitteena oli tehdä lyhyt tarkastelu eri dokumentointiohjelmista, joita pohjan luomiseen voisi käyttää.

Dokumenttipohjan luomista varten tarvittavan tiedon ja dokumentointiohjelmista tarvittavan tiedon hankkimiseksi on opinnäytetyössä käytetty useita eri menetelmiä ja tietolähteitä parhaan mahdollisen lopputuloksen saamiseksi. Merkittävin menetelmä on ollut itsenäinen tiedonhaku internetistä. Internetin lisäksi on tietoa haettu kirjoista niin, että on keskitytty lähinnä standardeihin. Standardit ja konedirektiivi, jonka piiriin toimeksiannon antanut yritys kuuluu, loivat perustan koko käyttöohjeen luomiselle. Konedirektiivissä on tarkasti määritelty asiat, joita käyttöohjeessa pitää vähintään mainita, jotta käyttöohje on kyseisen direktiivin mukainen.

Benchmarkingia on käytetty, kun on otettu mallia jo olemassa olevista käyttöohjeista ja niiden sisällöstä. Benchmarkingin ohella aiheesta on keskusteltu yrityksen edustajien kanssa ja pohdittu, mitä asioita käyttöohjeessa olisi hyvä olla tai mitä ominaisuuksia dokumentointiohjelmalta vaaditaan. Dokumentointiohjelmista on kokemuksia ja tietoa saatu kokeilemalla eri ohjelmia ja lukemalla niiden ominaisuuksista.

Yrityksen omat tarpeet, mielipiteet ja koko huomioon ottaen parhaimmaksi ohjelmaksi todettiin Microsoft Officen ohjelmat. Käyttöohjeen luomiseen, komponenttien luettelemiseen ja erilaisten pöytäkirjojen tekemiseen käytettiin Word-, Excel- ja Access-ohjelmia. Vertailtavina ohjelmina olivat toiminnanohjausjärjestelmä SAP, verkkosivujen tekemiseen käytetty WordPress, M-Files ja Microsoft Officen ohjelmat.

Microsoft Officen ohjelmiin päädyttiin, koska ne on luotu toimimaan yhdessä. Tietojen synkronointi ohjelmien välillä on helppoa. Officen ohjelmat eivät myöskään ole riippuvaisia internetyhteydestä, ja niistä on jokaisella todennäköisimmin käyttökokemusta, joten kenenkään ei tarvitse opetella täysin uutta ohjelmaa ja siirtymä on helppo. Dokumenttipohja luotiin, tarkastelun perusteella yritykselle tässä vaiheessa, parhaaksi todettuun ohjelmaan.

The goal of this thesis was to create a document template for a corporation to help it in creating a user manual of the corporation´s products. The purpose was to create a universal template which can be used for all the corporation´s products. In this way every products user manual would follow the same formula and look the same. The aim was also to study different documentation programs or bases and compare their benefits and disadvantages. The program for the template creation was selected based on the review and its results.

The information for creating the template or the information on the documentation programs were gathered from many different sources and different ways. The major method was independent search of information on the internet. Along with the internet, information was also collected from books that focused mainly on standards and the Machinery Directive. The Machinery Directive created the whole base for the template. The minimum requirements that need to be included in the user manual, are stated in the directive. By following these requirements, the user manual will be made according the Machinery Directive.

In addition to the above-mentioned sources and methods, benchmarking was used. This means that the existing user manuals and their content were utilized in the thesis. Furthermore, discussions with the representatives of the corporation on the content of the user manual and the features that are required from the documentation program were held. Information about the programs were gathered by testing programs and reading about them on the internet.

Taking into account the corporation´s needs and opinions as well as the size of the corporation the best tool for creating and working with template was chosen to be Microsoft Office. The programs that were used from Microsoft Office were Word, Excel and Access. With these programs, it was possible to create the user manual, use some tables and make a list of different components. The programs that were compared were Microsoft Office, SAP, M-Files and WordPress.

The final selection was Microsoft Office because its programs are created to work together. In addition, it is easy to synchronize information between Word, Excel and Access. The fact that Office programs are not dependent on the internet, which makes their reliability high, affected the decision. Because nearly everyone has some kind of experience in Office, the transition would be easy and small-scale.