Millainen on hyvä dokumentaatio

Laitteistosta on hyvä olla selkeä dokumentaatio, eräänlainen asennuskirja. Jos mielii kilpailemaan, dokumentaatiota voidaan pitää pakollisena. Pakollisena siksi, että pintojen alla olevien asennusten laatua ja toteutusta on mahdotonta todeta ilman asennuksen aikaisia kuvia. Ja ilman todistettua asennusten laadukkuutta on myös mahdotonta saada siitä korkeita pisteitä.

Hyvä dokumentaatio on selkeä, järjestelmällinen ja sisältää kaikki olennaiset laitteistoon liittyvät asiat. Sen pohjalta arvostelu helpottuu ja nopeutuu. Samalla kilpailija pystyy todistamaan tuomareille asennusten olevan kunnossa myös pintojen alla.

Suuret, A4-kokoiset kansiot tai valokuva-albumit eivät välttämättä ole paras mahdollinen ratkaisu ahtaassa autossa. Asennustuomarit tutkivat kansiota autossa sisätiloissa, joten dokumentaation näppärä käsiteltävyys ja luettavuus ovat eduksi.

Dokumentaatiosta ei ole olemassa mitään määräystä, minkälainen sen tulisi olla. Tässä onkin hyvä paikka käyttää luovuutta ja toteuttaa jotain uutta ja erikoista, mitä ei ole aikaisemmin nähty. Kannattaa kuitenkin pitää mielessä, että yksinkertainen on kaunista; hyvin ja tarkasti toteutettu kansio voi monessa tilanteessa olla parempi ja tehokkaampi dokumentti kuin massiivinen multimediashow.

Dokumentaatiosta tulisi kuitenkin löytyä ainakin seuraavat asiat:

• Laitteistokaavio: selkeä kaaviokuva laitteista ja niiden kytkennöistä
• Kuitit laitteista, mikäli kilpailuluokka sen vaatii
• Valokuvia asennuksesta: Yksi hyvä ja tarkka valokuva kertoo enemmän kuin tuhat sanaa. Koska järjestelmän esittelyyn on varattu vain 7 minuuttia per kilpailija, on syytä päättää tarkasti, mitä aikoo sanoa ja minkä osan antaa kuvien kertoa .

Esimerkki laitteistokaaviosta

Yksinkertaisimmillaan hyvä laitteistokaavio voi olla yllä olevan esimerkin kaltainen. Linjatasoiset kytkennät on merkitty paksunnetulla katkoviivalla ja kaiutintasoiset kaapelit yhtenäisellä, ohuella viivalla. Kunkin laitteen kohdalle voi vielä merkitä kyseisen laitteen merkin ja mallin. Lisähienouksia voisi hakea esim. laitteiden "symbolien" korvaamista aidoilla kuvilla, mutta se ei ole millään muotoa pakollista. Edelleen on hyvä muistaa, että yksinkertainen on kaunista.

Asennuskuvat

Asennuskuvista on liikkeellä sitkeä harhaluulo; mitä enemmän, sen parempi. Ei pidä paikkaansa. Mikäli asennuksessa ei ole jotain todella erikoista ja poikkeavaa toteutusta, on turhaa kuvata samaa kiinnitysruuvia kolmesta eri kulmasta. Muutama hyvin valittu kuva per laite tai ratkaisu kertoo kyllä vaadittavat asiat. Jälleen kerran: Keep it simple! Autoa arvosteltaessa on varsin rasittavaa selata A4-kokoista kansiota, jossa on pari sataa kuvaa sikin sokin "ryhmiteltynä". Ja, kuten aikaisemmin mainittu: auto on ahdas paikka tutkia. Näppärä käsiteltävyys on eduksi.

Asennusvaiheessa on toki hyvä ottaa runsaasti kuvia, jotta loppuvaiheessa on mistä valita. Kuvien tulisi myös olla teräviä ja kunnolla valaistuja. Nykyisellään digikameroiden yleistyminen on tehnyt hyvien dokumentaatiokuvien ottamisesta entistä helpompaa, koska kuvan lopputuloksen näkee heti. Kuvausasentoihin tai tekniikkaan digikamerakaan ei tuo lopullista ratkaisua; ei ole mikään helppo toimenpide maata jalkatilassa ja yrittää kuvata pimeää nurkkaa kojelaudan alla, mutta silti...

Esimerkkejä asennuskuvista

Hyvä kuva asennuksen vaiheista. Elementin asennuspaikka on nähtävissä, eli lähtökohta kiinnityksineen, samoin kuin lopputulos. Yhteen kuvaan on siis liitetty kolme kuvaa eri vaiheista. Tästä on hyvä lähteä liikkeelle kaiuttimien asennusta kuvattaessa. Tällainen kuva ei kuitenkaan ole välttämätön, ellei modifiointiin liity jotain poikkeuksellista tai mainittavaa.

Niin, soitin/DSP ja nippu johtoja, mutta missä? Miten laite on kiinnitetty? Mihin se on kiinnitetty? Onko se kiinnitetty? Saako kuvasta itse asiassa mitään selvää? Tämä kuva on erinomainen, mutta huonompikin ajaa asiansa.

Asennuskuvat tulisi myös ryhmitellä selkeästi, vaikkapa välilehtien avulla eri osa-alueisiin (johdotus, soitin ja niin eteenpäin.). Eikä kuvateksteistäkään, siisteistä sellaisista, ole haittaa. Päinvastoin.

Ohjenuorana voitaisiin pitää sitä, että dokumentaatio etenee samaa rataa kuin varsinainen asennuskin. Kun tietää miten esimerkiksi vaimennus ja johdotus on toteutettu, on tämän tiedon pohjalta helpompaa suhtautua muun asennuksen laatuun. Eri osakohteissa on myös syytä mennä saman kaavan mukaisesti. Osien valmistuksesta ja keskinäisestä sovittelusta kohti valmista asennusta, kokonaisuutta.

Mihin tarvitsen laitteistoni dokumentaatiota?

Dokumentaation tärkein tehtävä on todistaa, mistä laitteista ja miten järjestelmä on koottu. Esimerkiksi johdotuksen siisteyden toteaminen ohjaamossa on varsin hankala tehtävä ilman kunnollisia valokuvia, dokumentaatiota.

Dokumentaatiosta jää myös "muisto" menneistä järjestelmistä, ja saattaapa sen tutkiminen helpottaa järjestelmän purkamistakin, mikäli kokoamisesta on pitkä aika: ”Jaa, tuollakos se ruuvi olikin”.

Kilpailutilanteessa kunnollinen dokumentaatio on oikeastaan itsestäänselvyys. Ilman sitä on vaikeaa todistella, kuinka hyvin on asiat tehnyt.

Takaisin ylös | Takaisin opetusohjelmaan