Lahenduste vormistamise juhend
Dokument
Ülesande lahendus vormistatakse kirjalikult - analüütilise aruandena, mudelina, intervjuu protokollina vms dokumendina. Dokument sisaldab tavaliselt teksti ja skeeme. Dokument peab olema vormistatud korrektselt, järgides ühelt poolt IT alal väljakujunenud head tava (professionaalne lähenemine), teiselt poolt akadeemilist tava tööde vormistamisel ülikoolides. Mõnel juhul piisab, kui dokumendis on konspektiivsed märkmed ettekandeks. Täpsemalt selle kohta iga konkreetse ülesande juhistes.
Täiendused
Kui ülesande ettekandmisel praktikumis leitakse lahenduses olulisi vigu või puudusi, siis tuleb koostada ja järgmiseks praktikumiks e-postiga esitada lahenduse täiendatud, uus versioon. Täiendatud lahenduse vormistamisel tuleb kindlasti märkida, et tegu on mitte esimese versiooniga (nt kui esimese versiooni number oli 1.0, siis suurendada versiooni numbrit - 1.1 või 2.0).
Lahenduse dokumendi esitamine
Eelistatud ja tavapärane on esitamine faili saatmisega õppejõule. Kokkuleppel võib faili asemel saata viite veebis ülespandud dokumendile. Paberdokument esitatakse praktikumi või loengu alguses või lõpus.
Metaandmed
Dokument peab olema varustatud dokumenti, aga samuti dokumendi autorit kindlalt tuvastavate ja kirjeldavate nn metaandmetega: õppeaine kood ja nimetus, semester, autor(id), esitamise kuupäev. Kui lahendusest esitatakse mitu versiooni, siis tuleb näidata versiooni number või tähis. Need metaandmed peaksid olema dokumendi päises. Soovituslik on järgmine vorming:
IFI6068 Sissejuhatus infosüsteemidesse
Sügissemester 2013
Arvo METS, Maris MÄGI
18.09.2014 versioon 1.0
Pealkiri
Üheks metaandmeks on ka dokumendi pealkiri ehk nimetus. Igal dokumendil peab olema pealkiri (või nimetus). Pealkirjal võib olla täpsustav või täiendav alampealkiri. Ülesannete lahenduste korral peab pealkiri identifitseerima lahendatava ülesande numbri ja nimetuse. Näiteks:
ÜLESANNE 2 INFOVAJADUSTE VÄLJASELGITAMINE
Lahendusaruanne
...
dokumendi pealkiri
[alampealkiri]
Faili vorming
Fail peab olema üldlevinud, standardsete vahenditega avatav. Kindlad vormingud on näiteks pdf, rtf, HTML. Eraldi failides olevate piltkujutiste puhul on eelistatavateks üldlevinud vomingud: PNG, JPG. Edastatav fail ei tohi sisaldada makrosid ega muid elemente, mis võivad takistada faili avamist.
Faili nimi
Failide esitamisel peab faili nimi olema koostatud kindla süsteemi kohaselt. Mitteinformatiivsed ja ebasüstemaatilised failinimed raskendavad dokumentide läbivaatamist. Soovituslik on järgmine vorming:
IFI6068_YL_02_METS_MAGI.pdf
E-kiri
Elektrooniline dokument saadetakse e-kirja manusena. E-kirja teema (Subject:) peaks kindlasti sisaldama ülesande numbrit. Teema võib ühtida saadetava faili nimega. Näiteks:
From: Arvo Mets
Subject: IFI6068 Ülesanne 2
Viited veebidokumentidele
Kui dokumendi asemel esitatakse viide veebis ülespandud dokumendile, siis peab viide olema täpselt dokumendile. Viite alt peab avanema ainult esitatav dokument (mitte reklaamibännereid ega muud teavet).
Varukoopiad
Dokumendi esitaja peab alati alles hoidma koopia esitatud dokumendist (välja arvatud käsitsi kirjutatud, paberil esitatud dokumendid). See on vajalik puhuks, kui e-kiri mingil põhjusel ei jõua õppejõuni.
