Thesis preparation instructions: Difference between revisions

From Slavko Zitnik's research wiki
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 9: Line 9:
</blockquote>
</blockquote>


Ker se odločate za izdelavo zaključnega dela, naj najprej na kratko opišem, kaj se od tega dela pričakuje<ref name="Perry">Perry's Handbook, Sixth Edition, McGraw-Hill Co., 1984.</ref>:
Ker se odločate za izdelavo zaključnega dela, naj najprej na kratko opišem, kaj se od tega dela pričakuje<ref name="zahtevnost">Opis naj služi zgolj kot osnova. Končna ocena dela predstavlja kvaliteto izdelka, zato se lahko zahteve glede na izbiro specifične tematike razlikujejo.</ref>:
:;Diplomsko delo (VS)
:;Diplomsko delo (VS)
::V okviru diplomskega dela se pričakuje, da ste sposobni implementirati ali opisati določeno funkcionalnost. Pri tem morate znati pridobiti in izbrati ustrezna orodja ter izbiro tudi utemeljiti. Prikazati morate ustrezno delovanje glede na izhodiščne zahteve.
::V okviru diplomskega dela se pričakuje, da ste sposobni implementirati ali opisati določeno funkcionalnost. Pri tem morate znati pridobiti in izbrati ustrezna orodja ter izbiro tudi utemeljiti. Prikazati morate ustrezno delovanje glede na izhodiščne zahteve.
Line 17: Line 17:
::Poleg dela na UN se pričakuje, da je pregled sorodnega dela pripravljen bolj podrobno. Pri tem je potrebno izluščiti obstoječe pristope in kritično utemeljiti potrebe po novostih, ki bodo izdelane v vašem delu. Rezultate vašega dela je potrebno poleg prikaza tudi utemeljiti, jih kritično vrednotiti pod različnimi kriteriji ter primerjati z obstoječimi.
::Poleg dela na UN se pričakuje, da je pregled sorodnega dela pripravljen bolj podrobno. Pri tem je potrebno izluščiti obstoječe pristope in kritično utemeljiti potrebe po novostih, ki bodo izdelane v vašem delu. Rezultate vašega dela je potrebno poleg prikaza tudi utemeljiti, jih kritično vrednotiti pod različnimi kriteriji ter primerjati z obstoječimi.


=== Postopek izdelave zaključnega dela ===


Formalnega postopka glede izdelave ni definiranega. Pri diplomskih nalogah je predpisan rok za prijave in oddaje, pri čemer je za magistrske naloge poleg tega potrebno ob prijavi pripraviti še dispozicijo ter vmesno poročati o napredku. S kandidati se praviloma držim naslednjega postopka:
# Kandidat pregleda moja objavljena prosta zaključna dela in na podlagi tega pripravi svoj krajši opis, kaj bi si zastavil za cilj pri izdelavi zaključnega dela.
# V primeru uspešnega dogovora s kandidatom se tematika natančneje uskladi. Z vsakim kandidatom ustvariva skupno mapo na Google Drive, kjer vodiva naslednjo vsebino:
:::* Naslov in opis teme v slovenščini in angleščini. Končna verzija naslova in opisa se lahko pri diplomskih delih prilagodi tekom dela glede na dejanske rezultate.
:::* Povezavo do Github repozitorija.
:::* Povezavo do Overleaf projekta.
:::* Kontaktne podatke kandidata.
:::* Začetno strukturo/načrt/kazalo zaključnega dela.
:::* Zapiske sestankov in dogovorov tekom dela.
# Tekom dela se s posameznim kandidatom srečujeva po potrebi (videokonferenčno ali v živo) in rešujeva probleme ter določava plane. Z magistrskimi študenti navadno definiram redne mesečne sestanke vsaj do obveznega vmesnega poročanja.
# Zaradi enotnosti dela pri pregledu ne berem posameznih delov zaključnega dela, ampak celotno zaključeno delo v obliki PDF. Navadno prvi verziji sledijo približno tri iteracije popravkov zaključnega dela. Prvo verzijo zaključnega dela mi je za uspešno končanje potrebno oddati v pregled najmanj en mesec pred oddajo končnega dela v StudIS.
# '''(pomembno)''' Popravke pripravim kot anotacije v dokumentu PDF ali seznam popravkov po točkah. Ob poslani novi verziji mi morate poslati odgovore na moje komentarje in PDF s spremembami. Zaradi tega je pomembno, da si shranite tudi predhodno verzijo `.tex` dokumenta ([https://www.overleaf.com/learn/latex/Articles/Using_Latexdiff_For_Marking_Changes_To_Tex_Documents preverite več o latexdiff]).
# Ko je zaključno delo v primerni obliki za oddajo, ga oddate na StudIS, jaz pa oddajo potrdim.
# Zatem z referatom uskladimo način in termin zagovora.
# V času do zagovora pripravite predstavitev, ki mi jo lahko pošljete v pregled. Za predstavitev se navadno s kandidatom uskladiva in jo komentirava na dodatnem sestanku pred zagovorom.
# Na zagovoru mirno in samozavestno zagovorite svoje delo. Po zagovoru pridobite pravice in dolžnosti z novim nazivom, ki vam ga svečano podelijo na Univerzi v Ljubljani.
# Svoje pridobljeno znanje in veščine učinkovito uporabljate v svojo korist, korist svojih bližnjih in korist celotne družbe. Vsem kandidatom, ki zaključite študij na Univerzi v Ljubljani želim srečno in uspešno nadaljnjo pot. 
=== Pogoste napake/pomanjkljivosti v prvih verzijah zaključnega dela ===
Pri izdelavi zaključnega dela prosim sledite navodilom za pripravo zaključnih del, ki jih pridobite pri [https://ucilnica.fri.uni-lj.si/enrol/index.php?id=725 predmetu diplomski seminar] in v skladu s [https://fri.uni-lj.si/sl/napotki-za-pisanje-porocila smernicami za pripravo poročil tekom študija]. Kljub temu pa večina kandidatov v zaključnih delih zanemari naslednje:
* ''Stil in slog pisanja''. Zavedati se morate, da vaše zaključno delo predstavlja tehnično poročilo o vašem delu. Vaš namen je, da tematiko predstavite na način, da jo bo lahko razumel kdorkoli iz vašega strokovnega področja. Hkrati morajo biti opisi dovolj natančni, da bo lahko nekdo po branju vašega dela poustvaril vaš izdelek.
* ''Uporaba dvojnih narekovajev v okolju LaTeX''. V okolju LaTeX različno ustvarite levi in desni dvojni narekovaj. Levi narekovaj ustvarite z znakoma ''back-tick'' ``. Desni narekovaj pa ustvarite z dvema enojnima narekovajema <nowiki>''</nowiki>.
* ''Premalo grafičnih elementov''. Vaši izdelki večinoma uporabljajo neko metodologijo ali pa ste razvili nek proces, postopek, arhitekturo, ... Namesto suhoparnega opisa je nujno izdelati čimveč grafičnih prikazov, ki poenostavijo branje vašega dela. Imejte v mislih, da lahko vse te grafične elemente neposredno vključite v predstavitev vašega dela, kar bo še bolj zanimivo publiki.
* ''Podnaslavljanje slik in tabel''. Vsaka slika in tabela mora biti podnaslovljena. Bralec mora razumeti sliko ali tabelo, brez da bi bral besedilo okoli nje. Seveda mora biti vsak takšen element tudi citiran v besedilu in nuditi dodatno razlago, ki izhaja iz elementa. Pri podnaslovih ne pozabite na definicijo enot, virov, opisov posebnih oznak na elementu (npr. kaj pomeni odebeljeno besedilo), ipd.
* ''Izvorna koda kot posnetki zaslonov''. Izvorno kodo, psevdokodo, ipd. je potrebno vstaviti preko zato namenjenih okolij LaTeX (npr. verbatim, lstlistings). Vključevanje zaslonskih posnetkov kot slike v zaključno delo ni primerno.
* ''Organizacija poglavij''. Na začetku sodelovanja določiva predvideno strukturo zaključnega dela. Struktura je sicer odvisna od vašega pisanja in navadno morate tudi sami organizirati podpoglavja. Bodite posebej pozorni na to, da ima besedilo rdečo nit in lepo vodi bralca čez vaše delo. Predstavljajte si, da zaključno delo ni vaše, ne veste ničesar o tematiki, in bi morali to delo prebrati.
* ''Prekomerno navajanje uporabljenih orodij''. Pričakuje se, da uporabite različna orodja za dosego cilja. Nekatera orodja so ključnega pomena in jih je potrebno vključiti v opis, ostala pa so le podporna in se lahko kvečjemu omenijo. Na primer, specifični programski jezik ne igra posebne vloge, če bi lahko podobno dosegli z drugim programskim jezikom. Uporaba Git-a, določene verzije IDE-ja, ..., so le podporna orodja, ki so vam omogočila delo. Za razumevanje vašega dela, opis funkcionalnosti teh orodij ni pomemben (dasiravno ni to eksplicitni del vašega dela).
Poleg zaključnega dela so vaši rezultati dostopni tudi v javnem Git repozitoriju. Pri organizaciji repozitorija je pomembno, da omogoča drugim, da lahko vaš izdelek namestijo/zaženejo/... v svojem okolju. Zaradi tega mora vsebovati tudi datoteko README.md, kjer morate navesti vse pomembne podatke o vašem projektu. Ti so na primer namen projekta, vaše ime, navodila za pridobitev odvisnosti in dodatnih knjižnic/vzpostavitev okolja, navodila za prevajanje, navodila za zagon in osnovna navodila za uporabo orodja. Tekom svojega dela bodite pozorni na organizacijo repozitorijev odprtokodnih projektov in si ustvarite mnenje o dobro organiziranem repozitoriju. Sledite lahko tudi [https://www.freecodecamp.org/news/how-to-write-a-good-readme-file primerom dobrih praks].
----
<div class="references-small"> <references /> </div>
<div class="references-small"> <references /> </div>

Latest revision as of 16:38, 5 August 2022

Zaključno delo predstavlja zadnji korak vašega študija. V okviru tega dela prikažete del znanja, ki ste ga pridobili tekom študija - na fakulteti, s študentskim delom, z delom v društvih, ipd. Vaše delo predstavlja ogledalo odnosa do tematike, ki si jo izberete.

Pri pogovoru s kandidati večkrat slišim, da izobrazba nič ne šteje, da diplome/magistrskega dela nihče ne bere, in da torej v to delo ni vredno vlagati prekomernega truda. Da, morda je vse to deloma res, sploh za neregulirane poklice, kot je naš, vendar vseeno ima morda nek pomen.

Vaš trud pri študiju in zaključnem delu pomeni, da ste pripravljeni vložiti svoj čas in napor, da izdelate izdelek, kolikor dobro le lahko. Tudi pri tabornikih nekateri preidejo od udeležencev do vodij, ki morajo prevzemati več odgovornosti in dela, čeprav jim to ne prinaša nobenega zaslužka. Podobno je tudi v vseh ostalih društvih ali interesnih združenjih. Čeprav neposreden dobiček ni viden, to o teh posameznikih nekaj pove, kajne?

Mislim, da boste morali v času profesionalne kariere narediti kar nekaj stvari, za katere ne boste imeli neposredne motivacije. Poleg tehnične odličnosti boste morali osvojiti tudi mnogo drugih specialnosti, kot so na primer mehke veščine. Tisti, ki boste tekom razvoja napredovali, vodili ekipe, podjetja, projekte, ..., boste morda prišli do podobnih zaključkov.

Ker se odločate za izdelavo zaključnega dela, naj najprej na kratko opišem, kaj se od tega dela pričakuje[1]:

Diplomsko delo (VS)
V okviru diplomskega dela se pričakuje, da ste sposobni implementirati ali opisati določeno funkcionalnost. Pri tem morate znati pridobiti in izbrati ustrezna orodja ter izbiro tudi utemeljiti. Prikazati morate ustrezno delovanje glede na izhodiščne zahteve.
Diplomsko delo (UN)
Poleg dela na VS se pričakuje, da ste sposobni pridobiti in primerjati sorodne izdelke, ki so po funkcionalnostih podobni vašemu cilju. Te izdelke morate znati kritično vrednotiti in jih po potrebi prilagoditi, posodobiti, vključiti ali izdelati popolnoma na novo, da boste dosegli svoj cilj.
Magistrsko delo
Poleg dela na UN se pričakuje, da je pregled sorodnega dela pripravljen bolj podrobno. Pri tem je potrebno izluščiti obstoječe pristope in kritično utemeljiti potrebe po novostih, ki bodo izdelane v vašem delu. Rezultate vašega dela je potrebno poleg prikaza tudi utemeljiti, jih kritično vrednotiti pod različnimi kriteriji ter primerjati z obstoječimi.

Postopek izdelave zaključnega dela

Formalnega postopka glede izdelave ni definiranega. Pri diplomskih nalogah je predpisan rok za prijave in oddaje, pri čemer je za magistrske naloge poleg tega potrebno ob prijavi pripraviti še dispozicijo ter vmesno poročati o napredku. S kandidati se praviloma držim naslednjega postopka:

  1. Kandidat pregleda moja objavljena prosta zaključna dela in na podlagi tega pripravi svoj krajši opis, kaj bi si zastavil za cilj pri izdelavi zaključnega dela.
  2. V primeru uspešnega dogovora s kandidatom se tematika natančneje uskladi. Z vsakim kandidatom ustvariva skupno mapo na Google Drive, kjer vodiva naslednjo vsebino:
  • Naslov in opis teme v slovenščini in angleščini. Končna verzija naslova in opisa se lahko pri diplomskih delih prilagodi tekom dela glede na dejanske rezultate.
  • Povezavo do Github repozitorija.
  • Povezavo do Overleaf projekta.
  • Kontaktne podatke kandidata.
  • Začetno strukturo/načrt/kazalo zaključnega dela.
  • Zapiske sestankov in dogovorov tekom dela.
  1. Tekom dela se s posameznim kandidatom srečujeva po potrebi (videokonferenčno ali v živo) in rešujeva probleme ter določava plane. Z magistrskimi študenti navadno definiram redne mesečne sestanke vsaj do obveznega vmesnega poročanja.
  2. Zaradi enotnosti dela pri pregledu ne berem posameznih delov zaključnega dela, ampak celotno zaključeno delo v obliki PDF. Navadno prvi verziji sledijo približno tri iteracije popravkov zaključnega dela. Prvo verzijo zaključnega dela mi je za uspešno končanje potrebno oddati v pregled najmanj en mesec pred oddajo končnega dela v StudIS.
  3. (pomembno) Popravke pripravim kot anotacije v dokumentu PDF ali seznam popravkov po točkah. Ob poslani novi verziji mi morate poslati odgovore na moje komentarje in PDF s spremembami. Zaradi tega je pomembno, da si shranite tudi predhodno verzijo `.tex` dokumenta (preverite več o latexdiff).
  4. Ko je zaključno delo v primerni obliki za oddajo, ga oddate na StudIS, jaz pa oddajo potrdim.
  5. Zatem z referatom uskladimo način in termin zagovora.
  6. V času do zagovora pripravite predstavitev, ki mi jo lahko pošljete v pregled. Za predstavitev se navadno s kandidatom uskladiva in jo komentirava na dodatnem sestanku pred zagovorom.
  7. Na zagovoru mirno in samozavestno zagovorite svoje delo. Po zagovoru pridobite pravice in dolžnosti z novim nazivom, ki vam ga svečano podelijo na Univerzi v Ljubljani.
  8. Svoje pridobljeno znanje in veščine učinkovito uporabljate v svojo korist, korist svojih bližnjih in korist celotne družbe. Vsem kandidatom, ki zaključite študij na Univerzi v Ljubljani želim srečno in uspešno nadaljnjo pot.

Pogoste napake/pomanjkljivosti v prvih verzijah zaključnega dela

Pri izdelavi zaključnega dela prosim sledite navodilom za pripravo zaključnih del, ki jih pridobite pri predmetu diplomski seminar in v skladu s smernicami za pripravo poročil tekom študija. Kljub temu pa večina kandidatov v zaključnih delih zanemari naslednje:

  • Stil in slog pisanja. Zavedati se morate, da vaše zaključno delo predstavlja tehnično poročilo o vašem delu. Vaš namen je, da tematiko predstavite na način, da jo bo lahko razumel kdorkoli iz vašega strokovnega področja. Hkrati morajo biti opisi dovolj natančni, da bo lahko nekdo po branju vašega dela poustvaril vaš izdelek.
  • Uporaba dvojnih narekovajev v okolju LaTeX. V okolju LaTeX različno ustvarite levi in desni dvojni narekovaj. Levi narekovaj ustvarite z znakoma back-tick ``. Desni narekovaj pa ustvarite z dvema enojnima narekovajema ''.
  • Premalo grafičnih elementov. Vaši izdelki večinoma uporabljajo neko metodologijo ali pa ste razvili nek proces, postopek, arhitekturo, ... Namesto suhoparnega opisa je nujno izdelati čimveč grafičnih prikazov, ki poenostavijo branje vašega dela. Imejte v mislih, da lahko vse te grafične elemente neposredno vključite v predstavitev vašega dela, kar bo še bolj zanimivo publiki.
  • Podnaslavljanje slik in tabel. Vsaka slika in tabela mora biti podnaslovljena. Bralec mora razumeti sliko ali tabelo, brez da bi bral besedilo okoli nje. Seveda mora biti vsak takšen element tudi citiran v besedilu in nuditi dodatno razlago, ki izhaja iz elementa. Pri podnaslovih ne pozabite na definicijo enot, virov, opisov posebnih oznak na elementu (npr. kaj pomeni odebeljeno besedilo), ipd.
  • Izvorna koda kot posnetki zaslonov. Izvorno kodo, psevdokodo, ipd. je potrebno vstaviti preko zato namenjenih okolij LaTeX (npr. verbatim, lstlistings). Vključevanje zaslonskih posnetkov kot slike v zaključno delo ni primerno.
  • Organizacija poglavij. Na začetku sodelovanja določiva predvideno strukturo zaključnega dela. Struktura je sicer odvisna od vašega pisanja in navadno morate tudi sami organizirati podpoglavja. Bodite posebej pozorni na to, da ima besedilo rdečo nit in lepo vodi bralca čez vaše delo. Predstavljajte si, da zaključno delo ni vaše, ne veste ničesar o tematiki, in bi morali to delo prebrati.
  • Prekomerno navajanje uporabljenih orodij. Pričakuje se, da uporabite različna orodja za dosego cilja. Nekatera orodja so ključnega pomena in jih je potrebno vključiti v opis, ostala pa so le podporna in se lahko kvečjemu omenijo. Na primer, specifični programski jezik ne igra posebne vloge, če bi lahko podobno dosegli z drugim programskim jezikom. Uporaba Git-a, določene verzije IDE-ja, ..., so le podporna orodja, ki so vam omogočila delo. Za razumevanje vašega dela, opis funkcionalnosti teh orodij ni pomemben (dasiravno ni to eksplicitni del vašega dela).

Poleg zaključnega dela so vaši rezultati dostopni tudi v javnem Git repozitoriju. Pri organizaciji repozitorija je pomembno, da omogoča drugim, da lahko vaš izdelek namestijo/zaženejo/... v svojem okolju. Zaradi tega mora vsebovati tudi datoteko README.md, kjer morate navesti vse pomembne podatke o vašem projektu. Ti so na primer namen projekta, vaše ime, navodila za pridobitev odvisnosti in dodatnih knjižnic/vzpostavitev okolja, navodila za prevajanje, navodila za zagon in osnovna navodila za uporabo orodja. Tekom svojega dela bodite pozorni na organizacijo repozitorijev odprtokodnih projektov in si ustvarite mnenje o dobro organiziranem repozitoriju. Sledite lahko tudi primerom dobrih praks.




  1. Opis naj služi zgolj kot osnova. Končna ocena dela predstavlja kvaliteto izdelka, zato se lahko zahteve glede na izbiro specifične tematike razlikujejo.