Spodnji vzorec je na razpolago tudi v obliki dokumenta PDF. 

Miha Novak in Micka Kovačeva

Vzorec poročila

Domača naloga pri predmetu Splošne teme

MENTOR: doc. dr. Lojze Pridanič

Prvi del poročila naj vsebuje kratek povzetek, v katerem predstavite tematiko, ki jo obravnava vaše delo, in v nekaj stavkih povzemite najpomembnejše poudarke ter glavne ugotovitve. Potencialni bralec se pogosto na podlagi povzetka odloči, ali bo z branjem dela nadaljeval, zato morate biti v povzetku kratki, jedrnati in prepričljivi. Besedilo mora biti napisano natančno in tehnično korektno.

1. Uvod

Uvodno poglavje je namenjeno hitremu informiranju bralcev. Tu avtor opiše problem ter predstavi načine reševanja in kratek pregled literature (dela, ki jih je prebral in uporabil kot referenco pri svojem delu). Iz pregleda skušajte izpeljati sklep (ali izpostavite pomanjkljivosti del ali pa navedite, katera so najprimernejša za vašo nalogo).

Poročilo je namenjeno podajanju informacij, zato mora biti napisano strokovno, oblikovno in slovnično pravilno. V tem dokumentu je podanih nekaj osnovnih navodil in nasvetov za pravilno pisanje poročila. Primerno obliko poročila lahko razberete kar iz oblike tega dokumenta (ki vam zato lahko služi kot predloga). Za strokovno pravilnost mora skrbeti avtor sam; podatki, ki jih navaja v poročilu, morajo biti pravilni, preverjeni in primerno citirani (glej poglavje 5). Jezikovna pravilnost pomaga pri razumevanju vsebine, zato je pomembno, da se avtor pravilno slovnično izraža. Nekaj napotkov pravilne uporabe slovenskega jezika si preberite v poglavju 4.

2. Struktura poročila

Poročilo običajno vsebuje več poglavij, začne se z Uvodom in konča z Zaključkom, vmes pa je eno ali več poglavij (število poglavij je odvisno od same vsebine). Poglavij naj ne bo preveč, dodatno strukturiranost dokumenta lahko dosežemo s podpoglavji (tudi teh naj bo ravno prav!). Naslovi poglavij naj bodo kratki in jedrnati.

2.1 Podpoglavja

Za večjo preglednost poročila lahko uporabljate podpoglavja, ki morajo biti primerno številčena (številki poglavja sledi zaporedna številka podpoglavja).

2.2 Drugo podpoglavje

Če je vsebina poročila taka, da zahteva še večjo strukturiranost, lahko uporabite tudi primerno številčena podpodpoglavja. Večja globina strukturiranosti (npr. podpodpodpoglavja) pa se odsvetuje. Na podpoglavja se sklicujte z besedo »poglavje«. Na primer: »Poglavje 2.1 je zelo kratko.«

3. Grafični elementi

Poleg besedila so pomembni sestavni deli tehničnega poročila tudi grafični elementi (enačbe, slike, tabele …), ki pripomorejo k lažjemu razumevanju besedila.

Pri pisanju upoštevajte pravila za stavljenje strokovnih tehničnih tekstov. Matematični simboli naj bodo pisani v kurzivi, fizikalne konstante in enote ter matematične funkcije pa pokončno. Enačbe oštevilčite z zaporedno številko v oklepaju na desni strani formul in se tako nanje tudi sklicujte.

Slika 1: Pisanje poročila je zahtevno opravilo.

V poročilo vključujte slikovne prikaze (grafe, sheme, ilustracije, zaslonske izrise ipd.), ki pripomorejo k razumljivosti in berljivosti naloge. Slike morajo biti oštevilčene in navedene v besedilu ter opremljene z ustreznim naslovom (neposredno pod sliko), ki opiše, kaj je na sliki. V besedilo so slike vstavljene približno tam, kjer se nanje prvič sklicujemo. Slike in naslov poravnajte sredinsko (glej sliko 1). V primeru, ko slika ni vaše avtorsko delo, takoj po opisu slike navedite referenco, na kateri ste sliko dobili. Praviloma so slike v objavljenih člankih in knjigah (tudi spletnih) avtorsko zaščitene in se jih ne sme uporabljati v lastnih strokovnih delih brez avtorjevega dovoljenja.

Morebitne številske rezultate svojih eksperimentov v poročilu strnite v tabelah. Tudi te naj bodo oštevilčene in naj vsebujejo naslov tabele, ki je postavljen, tako kot pri slikah, neposredno pod njo. Na vse tabele in slike se je treba v besedilu sklicevati in morajo biti navedene v besedilu. V besedilo naj bodo vstavljene približno tam, kjer se nanje prvič sklicujemo. Na primer, slika 1 je zelo povedna, kvantitativni rezultati v tabeli 1 pa to potrjujejo.

Tabela 1: Kvantitativna analiza pisanja tekstov. Tabela prikazuje pričakovan in izmerjen čas pisanja diplomske naloge pri treh naključno izbranih študentih.

4. Slovnični nasveti

Za boljši slog in pravilnost vaših besedil bi vas radi opozorili še na nekaj najpogostejših napak, ki jih opažamo v pisnih izdelkih.

Pri večbesednem lastnem stvarnem imenu pišemo z veliko začetnico le prvo besedo (naslednje pa le, če gre za besede, ki jih pišemo z veliko začetnico iz kakih drugih razlogov). Tako kot za Smrt trgovskega potnika, Orient ekspres in Umor na Orient ekspresu to velja tudi za programe, torej Telefonski imenik Slovenije in ne Telefonski Imenik Slovenije. Pisanje vseh besed z veliko začetnico, ki se vsiljuje iz angleščine, ni pravilno, razen kadar gre za angleške nazive, npr. Microsoft Office.

Pravilno pišemo protokol TCP/IP, strežnik SQL, zahteva http, brskalnik Firefox in ne TCP/IP protokol, SQL strežnik, http zahteva in Firefox brskalnik (sploh pa ne SQL server, http request in Firefox browser). Prav tako ne pišemo o Intel procesorjih temveč o procesorjih Intel ali, veliko lepše, o Intelovih procesorjih. Pri delu morda uporabljamo programsko opremo Microsoft Office, nikakor pa ne Microsoft Office programske opreme. Prav tako nihče ne uporablja Open Office paketa, pač pa paket (ali zbirko) Open Office.

Pri sklanjanju tujih imen ne uporabljajte vezajev. Microsoft-ov operacijski sistem in Skype-ov vmesnik sta ravno tako nepravilna, kot bi bila Shakespeare-ov Hamlet in Merkur-jeva prodajalna.

Pika, klicaj in vprašaj so levostični: pred njimi ni presledka, za njimi pa. Klicajev in vprašajev se v strokovnih besedilih sicer izogibajte. Oklepaji so desnostični in zaklepaji (takole) levostični.

Pri pisanju vejic se spomnite na preprosto pravilo: povedki so med seboj ločeni z vejicami, razen če so zvezani z in, pa, ter, ne–ne, niti–niti, ali, bodisi, oziroma. Poleg tega imamo vejice, seveda, pri vrinjenih stavkih, pristavkih, naštevanjih ... Primer, ko nam pravilo pomaga: razmere so boljše kot prejšnja leta. A vendar: razmere so boljše, kot so bile prejšnja leta.

Odvečne vejice niso pogoste le pri vezniku kot, temveč jih pogosto zmotno postavljamo za dolgimi »uvodi« v stavek. Vse vejice v naslednjih stavkih so nepotrebne. Pri programiranju tega zahtevnega in programerju relativno nenaklonjenega žepnega računalnika, si bomo lahko pomagali z Visual Studiom. Za hitrejše pomikanje po dokumentu, pritisnemo desno tipko miške in miško premaknemo na rob naslova. Kljub temeljiti preiskavi, napake niso našli. Po večletnem prizadevanju vse skupine, so projekt končno uresničili. Tako kot Kohavija in Johna, tudi nas zanima vpliv prisotnosti koreliranih atributov vpliva na delovanje algoritma. Zaradi slabših rezultatov in počasnejšega izračuna matrik po vzoru ReliefFa, smo se v poskusih omejili na opazovanje Ashenhurstove matrike. Podobno kot pri konstruktivni indukciji z Bayesovo metodo, smo tudi tu najprej opazovali pravilnost novih konceptov. Da so te vejice odveč, spet najlažje opazimo po tem, da v prvem delu stavka ni nobenega povedka (oz. glagola).

Vejice ne pišemo med večbesednimi vezniki, kot so tako da, kljub temu da ... Pri tako da je vejica lahko pred tako ali pred da, odvisno od tega, kaj bi radi povedali. Če rečemo: »Deževalo je tako, da nismo mogli oditi,« je deževalo tako močno, da nismo mogli iz hiše. Pri: »Deževalo je, tako da nismo mogli oditi,« pa je pač deževalo (močno ali ne ...), zato nismo šli nikamor.

Veznik ter uporabimo, ko potrebujemo veznik z »manjšo prioriteto« kot in. »Pobral je šila in kopita ter šel« bi po računalniško zapisali kot »pobral je (šila in kopita) ter šel«. Če bi rekli, da je »pobral šila ter kopita in šel«, bi to pomenilo, da je »pobral šila ter (kopita in šel)«. Veznik ter uporabimo le, kadar ga potrebujemo. Ne pred in in ne pred ter ne pišemo vejice, razen kadar je pred njima konec vrinjenega stavka.

Svoj izraža osebkovo lastnino (osebek je del stavka, po katerem se vprašamo z kdo ali kaj). Razliko lepo začutimo na primeru: »Jože je odšel iz pisarne. Zvone je hitro pojedel svoj sendvič; Jože je medtem peljal na kosilo svojo ženo.« Obratno pa se zgodba glasi: »Jože gre iz pisarne. Zvone je hitro pojedel njegov sendvič; Jože je medtem peljal na kosilo njegovo ženo.« Vsak študent mora napisati svojo diplomo, nihče njegove.

Pri pisanju pogosto uporabljamo nepotrebne fraze, ki so se prijele zaradi napačne rabe. Veznik pa se uporablja v protislovnih priredjih, kot na primer poleti je vroče, pozimi pa mraz. Običajno je večina veznikov pa odvečnih. Fraza tri leta nazaj prihaja iz angleščine (three years ago); v slovenščini rečemo pred tremi leti. Namesto veznika v kolikor bi bilo v primerih, v katerih ne izražamo količine, primerneje uporabiti če.

Pri pisanju se izogibajte odvečnim tujkam in jih, kjer je mogoče in smiselno, nadomeščajte s slovenskimi sopomenkami, kot npr. samodejno, odstotek, poskus in težava namesto avtomatsko, procent, eksperiment in problem. Obenem pa se izogibajte tudi nasilnemu prevajanju in kvazi-prevajanju ter se o sumljivih prevodih (kot je npr. konkurenčnost, ki ne ustreza angleškemu concurrency, sočasnosti) posvetujte z mentorjem.

5. O navajanju virov

Obvezni sestavni del poročila je tudi poglavje Literatura, v katerem navedemo vire, ki smo jih uporabili v poročilu. Poglavje Literatura ni oštevilčeno. Viri naj bodo navedeni v določenem vrstnem redu (npr. po abecednem vrstnem redu priimkov avtorjev ali po vrstnem redu pojavitve referenc – kot v teh napotkih). Navajajo naj se le tisti viri, na katere se v besedilu sklicujete! Dolg seznam ni dokaz, da imate dober pregled nad literaturo.

Za navajanje virov uporabite slovensko inačico oblike IEEE. V tej obliki se viri (članek v zborniku konference [2], knjiga [3], članek v reviji [4] in spletna stran [5]) navedejo, kot to prikazujejo primeri v poglavju Literatura.

5.1   Seznam virov

V poglavju Literatura zapišemo seznam vseh virov, ki smo jih uporabili v poročilu. V seznamu navedemo le tiste vire, na katere se v besedilu tudi sklicujemo. Viri naj bodo navedeni po abecednem vrstnem redu priimkov avtorjev.

5.2   Primeri navajanja literature

Sklicevanje na vir se v besedilu poročila označi z zaporedno številko vira v oglatem oklepaju, npr. [2] oziroma [2], [3], kadar se na istem mestu sklicujemo na več različnih virov. Zglede za druge vrste virov je mogoče dobiti v revijah IEEE, ki so na voljo v knjižnici, ali na spletnem naslovu [6]. Uporabna so tudi navodila [7]. Zelo pomembno je, da literaturo navedete pravilno (avtor, naslov dela ter kje in kdaj je bilo delo objavljeno).

6. Zaključek

Poročilo odraža kvaliteto vašega dela. Če boste izjemno delo predstavili v slabem poročilu, vašega dosežka nihče ne bo opazil.  Zato se pri izdelavi poročila splača potruditi in natančno opisati rezultate dela. S tem boste prepričali mentorja in vse potencialne bralce in vaš trud ne bo zaman. Poleg tega lahko na pisanje poročila gledate kot na vajo za pisanje diplome. Če diploma sledi nekaj dobro napisanim poročilom, se bo to poznalo tudi na njeni kakovosti.

Literatura

[1] P. A. Bernstain in U. Dayal, "An overviev of repository technology", v zborniku 20th Intl. Conference on Very Large Databases, Santiago, Chile, sept. 1994, str. 705-713.

[2] R. Ramakrishnan, Database Management Systems, New York: McGraw-Hill, 1998.

[3] R. D. Semmel in D. P. Silberg, "Extended entity-relationship model for automatic query formulation", Telematics and Informatics, št. 10, zv. 3, str. 301-317, 1993.

[4] PDF/A. Wikipedia [Online]. Dosegljivo: http://en.wikipedia.org/wiki/PDF/A (zadnji obisk 1.1.2017).

[5] GNU General Public Licence. (junij 2007). GNU Operating System [Online]. Dosegljivo: https://www.gnu.org/copyleft/gpl.html (zadnji obisk 1.1.2017).

[6] Z. Oven. NAVODILA za sklicevanje (citiranje) in navajanje uporabljenih virov v IEEE načinu. (oktober 2013). Knjižnica Fakultete za elektrotehniko [Online]. Dosegljivo: http://www.fe.uni-lj.si/mma/Navodila-za-citiranje---IEEE-način/2013093012342504/ (zadnji obisk: 1. 1. 2017).

[7] Creative Commons Slovenia. [Online]. Dosegljivo: http://creativecommons.si (zadnji obisk 1.1.2017).

[8] EndNote® Online. (2014). Thomson Reuters [Online]. Dosegljivo: http://www.myendnoteweb.com/help/en_us/ENW/help.htm (zadnji obisk 1.1.2017).

[9] IEEE Information for authors. (marec 2007). IEEE Periodicals, Transactions/Journals Department [Online]. Dosegljivo: http://www.ieee.org/documents/auinfo07.pdf (zadnji obisk 1.1.2017).