Palvelinvaihdosten tekninen dokumentaatio

Abstract

Teknisellä dokumentaatiolla tarkoitetaan kaikkea dokumentaatiota, joka liittyy tuotteeseen tai tuotteisiin. Se voi pitää sisällään käyttöohjeita, huolto-ohjeita, asennusohjeita ja muita verkossa tarjolla olevia ohjeistuksia. Teknisen dokumentaation toteutus voidaan jakaa suunnittelu-, luonnostelu-, läpikäynti-, tarkistamis-, muokkaus ja julkaisuvaiheeseen.

Tekninen kirjoittaminen liittyy vahvasti tekniseen dokumentaatioon, sillä kirjoittamisen avulla monimutkaiset prosessit saadaan kirjalliseen muotoon. Jotta dokumentointi ja tekninen kirjoittaminen ovat laadukasta, kirjoittajan ei tarvitse tuntea aihetta. Tärkeitä taitoja ovat tiedonkeruu, teknisen kirjoittamisen käytäntöjen hallinta sekä laadunhallinta.

Opinnäytetyön tavoitteena oli tuottaa toimeksiantajalle tietoa teknisestä dokumentaatiosta, jotta heillä on mahdollisuus kehittää omaa dokumentaatiotaan. Tieto hankittiin keräämällä sitä eri lähteistä sekä haastattelemalla muutamia yrityksen työntekijöitä. Opinnäytetyössä selvitetäänkin hieman yrityksen teknisen dokumentaation yleistä tilaa. Tämän jälkeen käydään läpi sitä, millainen dokumentaation tila on yksittäisessä tiimissä ja mitä palvelinvaihdosten aikana tulisi kirjata ylös, jotta työskentelystä tulisi tehokasta ja sujuvaa. Opinnäytetyön tuotoksena syntyi muutama erilainen mallipohja käytettäväksi palvelinvaihdosprosessin eri vaiheisiin.

Lopputuloksissa pohditaan dokumentaation hyötyjä tarkasteltavan tiimin sekä organisaation kannalta. Lisäksi mietitään dokumentaation haasteita ja sitä, miksi dokumentaatiota ei välttämättä lähdetä opinnäytetyöstä huolimatta kehittämään.

The word technical documentation stands for all the documentation which is connected to a device or a product. It can contain instructions, service manuals, installation manuals as well as every other kind of a guidance manual provided in the internet. Execution of the technical documentation can be divided to 6 different parts including planning, drafting, review, inspection, modification and publishing.

Term technical writing is strongly connected to technical documentation as by using technical writing you can convert all the complicated processes to a written form. To achieve a high-quality technical documentation and technical writing the writer doesn’t need to know the topic. Most important skills are data collection, good knowledge of technical writing practices and quality control.

The goal of the thesis was to deliver information about technical documentation to mandator of thesis, so they have a chance to improve their own documentation. The information in thesis is gathered from different sources and interviews from corporation employees. The thesis generally clarifies the current state of technical documentation in the corporation and more specifically clarifies the state of technical documentation of server changes in a certain team. The thesis originated a few different mock-ups of documentation foundations about the process of server changes technical documentation.

The result of thesis speculates the benefits of technical documentation from the viewpoint of a team and an organization. The thesis ponders over the possible challenges of documentation and reasons why despite of the thesis the ways of documentation may not still be improved in the future.