Smernice za pripremu tehničkog rada
Contents |
Uvod
Ove smernice su primenljive na pripremu članka, projekta, seminarskog i diplomskog rada, magistarske teze ili doktorske disertacije.
Osnovna struktura dokumenta
Dokument imenujte dovoljno jasno da kasnije može da se locira ili prepozna. Imena poput Projekat.doc ili Diplomski.odt samom autoru možda nešto i znače, ali to sigurno nije slučaj za primaoca koji dobija stotine takvih datoteka. Zato je najbolje u ime staviti kratki oznaku svrhe (kao što je skraćenica predmeta ili konferencije ili naziv namene, npr. "Master")), lično ime, prezime, opcinoi lični ID (npr. broj indeksa) i (sažeti) naslov.
Pre uvoda ide sadržaj: poglavlja i odeljci, eventualni spisak (indeks) tabela i spisak slika.
Uvod i zaključak su najbitniji u celom tekstu. Za razliku od unutrašnjih poglavlja, oni se obično ne numerišu. U njima ne treba ulaziti u tehničke i druge detalje koji su strani prosečnom čitaocu koji mora da bude u stanju da stekne opštu predstavu o radu na osnovu ova dva dela. No po svaku cenu treba izbeći sumnjive ukrase poput koji pokušavaju da problematiku na neki način vežu za život, poput "Zdravlje je najvrednija stvar u životu", "Zdravlje nema cenu", ili promovišu podrazmevane ili uobičajene stvari u velika dostignuća: "Doprinos rada je što pruža mogućnost kreiranja, pregleda i promene podataka o [nečemu]..., što omogućava konkurentno korišćenje i instalaciju na samo jednom mestu, jer je realazovan kao veb aplikacija." U poslednjem kotraprimeru je dodatni problem to što se rešenje, čija su implementacija ili opis bili deo zadatka, brka sa samim radom, koji je dokument. Još je gore kada se rad koji daje tek pregled neke teme ili je malo zagrebe tretira kao nešto što u okviru te teme daje bitan doprinos ili rešenje. Ne može se značaj teme ili oblasti direktno projektovati na značaj samog rada, i tu vezu treba pažljivo postaviti.
Uvod za diplomski treba da bude bar na jednoj strani, za magistarski više (prosto: sta je okvirna tema ili oblast, sta je bio zadatak ili je rađeno, kako je organizovan dokument po glavama i to sa pasusom o svakom poglavlju). Kod članka, dole opisani "Introduction" ima ulogu uvoda, a kod rada koji je duži od članka, "Introduction" je tehnički ulaz u temu i detaljniji opis oblasti, problema i zadatka, što rasterećuje osnovni uvod.
Glavno telo teksta treba da generalno bude u skladu sa sledećom strukturom, s time da naslovi pojedinih poglavlja ili sekcija mogu biti prilagiđeni konkretnoj temi:
- Opis problema (Introduction - Background: entities, problem, detailed current problem handling, what tools currently exist, limitations and problems in handling paradigm, user view, target environment, resulting changes in standard procedure, usage in teaching, training or research, future applications, possible new directions)
- Postupak rešavanja (Materials and methods - What we have made, short list and description of elements or methodology phases, overall methodology. 2-3 paragraph description of each element, describing method, implemented procedure, assumptions, element environment or platform)
- Opis rezultata ili realizovanog rešenja (Results - Usability evaluation and/or comparison with the reference (i.e. initial approach), features through description of system appearance, snapshots, usage description)
- Analiza rezultata (Discussion - What is presented, focus areas during problem solving, usability, addressed problems, remaining and open issues, what is learned, benefits and impact of the new system, possible improvements)
Opis pristupa i arhitekture, opis izvršnog okruženja i procedura i opis razvojnog okruženja i postupaka treba jasno razdvojiti. Svaki od ovih elementa treba pokriti u onom obimu u kome je prisutan i značajan u okviru celine rada, a u skladu sa gore navedenom strukturom. Na kraju slede:
- Zaključak (Conclusions - Long term objective/goal, what is done (chronologically or following the data flow), introduced concepts, usability of applied concept or implemented solution, impact)
- Zahvalnice ( Acknowledgments - Institutions, persons, grants)
- Reference (References)
Zaključak za diplomski mora imati bar jednu stranu, za master i magistarski više. U zaključku staviti pregled onoga sta je rađeno, sta je naučeno, sto je korišćeni pristup bolji od starih, sta bi trebalo dalje raditi i sta se zamera metodologiji i razvojnim alatima i slične napomene. Otprilike slično uvodu ali iz perspektive onoga koji vlada materijom i koji je prošao kroz urađeno, dok je to u uvodu bilo sa ciljem upoznavanja čitaoca.
Na samom kraju se mogu, po potrebi, dodati i prilozi.
Tehnička priprema i format dokumenta
Opšte formatiranje
Za studentske radove, teze i disertacije obično ne postoji zvanični obrasci. Ipak, na početku proverite da li postoje propisani šabloni, što je vrlo čest slučaj za članke u poblikacijama, ili su izgled naslovne strane, prateći dokumenti ili struktura teksta propisani, kao na beogradskom ETF-u: Studiranje > Master studije , Naslovna.
Poželjno je tekst bude pisan u MS Word-u ili Libre/Open Office-u. Prihvatljiv je i LaTex i drugo, dokle god postoji i generisani PDF. Veličina slova ne sme da bude manja od 10 pt, a preporučena veličina je 11 pt. Kod teksta na engleskom, prored između pasusa može biti uvećan na bude 1.5 red, a na srpskom je pasuse najbolje uvlačiti za 15-20 mm. Veličina strane treba da bude A4 (215 x 280 mm). Leva margina treba da bude 32 mm, a ostale tri najmanje 20 mm.
Ujednačiti izgled, uvlačenje i razmicanje karakterističnih delova dokumenta. Ovo se odnosi na naslove poglavlja, naslove sekcija, slike, tabele, potpise slika i tabela, reference, izvorni kod, numerisane pasusa i pasuse sa bullet-ima i sl. U slučaju MS Word-a, za ovo intenzivno i konzistentno koristiti jasan skup stilova.
Ne vršiti uvlačenje pasusa razmacima ili tab-ovima niti praviti razmake između pasusa, slike i teksta ili naslova poglavlja i teksta pomoću praznih pasusa - ovo se sme raditi samo u u segmentima koda. Telo teksta treba da je poravnato sa obe ili leve strane. Kada to nije unapred definisano, preporučuje se obostrano poravnanje, osim u listama kratkih stavki od kojih tek poneka pređe jedan red, kada levo poravnanje izgleda bolje; pasusi tela teksta treba da su ujedeni u prvom redu i/ili međusobno razmaknuti za pola reda; naslove poglavlja i sekcija ne treba centrirati.
Numeracija
Strane, osim naslovne, moraju biti numerisane. Do prve strane prvog poglavlja stanice su numerisane rimskim brojevima (i, ii, iii...), a od prvog poglavlja i zaključno sa poslednjom stranicom teksta stranice su numerisane arapskim brojevima (1, 2, 3...)
Oznake i brojevi poglavlja, sekcija, slika, tabela, reference i upotrebe reference treba da se automatski numerišu koristeći cross-reference mehanizam programa korišćenog za pripremu teksta, a ne da budu direktno ukucane u tekst. Pri tome 'poglavlje' sa referencama i prilozi ne treba da budu numerisani. Dakle
... 5 Zaključak 5.1 ... ... Reference Prilog A Prilog B
a ne
... 5 Zaključak 5.1 ... ... 6. Reference 7. Prilozi 7.1 Prilog A 7.2 Prilog B
Reference
Kada je god moguće, kao izvore treba koristiti naučne radove. Oni su, uglavnom, uz korišćenje KoBSON-a, dostupni u celini (http://kobson.nb.rs/kobson/nacini_pristupa.30.html). Kada se kriste novinski članci ili tekstovi sa veb sajtova, treba ih referencirati, čak i kada se koriste kao pomoć pri interpretaciji rada koji je i sam referenciran u radu koji se piše.
Reference treba da su zaista korišćene, odnosno referencirane u prethodnom tekstu koristeći uglaste zagrade. Ispred reference u tekstu se stavlja razmak, odnosno, ona se ne lepi sa prethodnom reči). One se mogu koristiti kao element rečenice (na primer, "[ABa, ZD05] analiziraju ovaj problem, koji se još ponegde pominje [XY08]."), a mogu i, poput fusnota, ne biti deo toka teksta (na primer, "To je opisano u literaturi [22,34].").
Fusnote, ako nije propisano drugačije, treba izbegavati. One ne služe za povezivanje teksta sa izvorima i nisu njegov integralni deo, već predstavljaju opremu teksta. Fusnote, kada se koriste, služe za dodatne napomene, komentare i pojašnjenja koji ne treba da budu integralni deo teksta.
Na mestima gde je neki tekst poslužio kao primarni izvor, mora se dati referenca na početku sekcije u kojoj se vrši sažeto prepričavanje. Ukoliko se ceo iskaz ili pasus prenose ili prevode u celini, treba ih, pored navođenja reference, zagradama označiti kao citat.
Ukoliko se referenca koristi da označi izvor slike, na kraju potpisa slike treba staviti referencu, "(Izvor: ...)" ili slično.
Opisi referenci moraju biti precizni i jednoznačni i počinjati sa autorima (ukoliko postoje) i naslovom. Izgled i redosled polja je ponekad unapred propisan. Reference moraju jednoznačno da imenuju izvor i omoguće da se izvorni dokument uvek može naći ili identifikovati. Ako je ikako moguće, treba obuhvatiti "Ko" (autori), "Šta" (naslov), "Gde" (časopis, konferencija, izdavač, brojevi strana, mesto konferencije ili izdavanja) i "Kada" (godina izdavanja). Za dokumente na internetu treba (pored ostalih raspoloživih elemenata i vremena pristupa) dati URL (ne kao link, već u obliku koji se čitljiv vidi se na papiru), za knjige moraju biti prisutni izdavač i godina, za članke i naziv časopisa/izdanja, broj časopisa, i brojevi strana na kojima je tekst). Ukoliko se daje URL, ispred njega mora biti naveden odgovarajući naslov (na primer, naslov veb stranice). Stavljanje samo URL-a kao reference je neprihvatljivo. Linkovi koju ukazuju na ceo sajt ili neku opštu stranicu, kao što je http://www.wikipedia.org/, su potpuno bespredmetni - referenca moraju da ukazuje na konkretan i precizan izvor korišćene informacije, sa dovoljno detalja (pre svega naslovom) koji identifikuju dokument i pošto se data adresa promeni ili ukine.
Lista reference ne sme biti tek puka lista bullet-a ili korišćene literature. One moraju biti sortirane po numeričkom ili alfabetskom redosledu. Ukoliko su označene numerički, onda moraju biti složene prema redosledu po kome se koriste u tekstu.
Čitalac se ne sme upućivati na sajt ispod koga je bezbroj strana, osim kada je to u svrhu identifikacije vlasnika sajta. To tada nije referenca, već se URL može dodati u objašnjenje imena ili skraćenice ustanove dato u zagradi, na primer "FDA (U.S. Food and Drug Administration, https://www.fda.gov/)".
Hiperlinkove u tekstu treba izbegaviti, a posebno ako se odredišna adresa ne vidi posle štampanja - ne može se kliknuti na odštampani hiperlink. Interni linkovi na sekcije samog dokumenta mogu biti prihvatljivi, jer predstavljaju puku navigacionu olakšicu, koja ne pruža značajnu dodatnu informaciju, osim one koju već i sam posebni format linka nagoveštava (plavo, podvučeno, kurziv...).
Sem referenci, koje su u načelu obavezne uvek kada niste sami sve smislili, izmerili i nacrtali, može se odvojeno dati i spisak ključne ili dodatne relevantne literature, koja, pošto tekstu nije direktno korišćena, ne treba biti referencirana. Ova lista predstavlja samo putokaz za dalje izučavanje teme, ali ne i dovoljno pokriće za korišćene izvore.
Slike
Slike i tabele treba da imaju potpis i da budu referencirane i protumačene u tekstu. Treba je smestiti što bliže mestu u tekstu gde se tumači. Potpis treba da bude ispod slike ili tabele. Potpis slike treba da ima oblik "Slika N.M: Opis slike", gde je N broj poglavlja, a M redni broj slike unutar istog. Ukoliko je slika preuzeta, na kraju potpisa se u zagradama ili pomoću reference može naznačiti odakle ona potiče.
Slike treba da budu jasne, jednostavne, uredne i funkcionalne, blizu mesta u tekstu na kome se opisuju ili referenciraju. Ukoliko slika nije originalna, treba u samoj slici ili njenom potpisu navesti izvor, npr imenovanjem originalnog autora, davanjem njegovog kopirajta, ili klasičnim referenciranjem dokumenta ili URL-a odakle je preuzeta. Slike treba da imaju svetlu (najbolje belu) pozadinu i da efikasno koriste prostor dokumenta. Treba ukloniti suvišne beline ili nebitne oblasti iz prikaza sadržaja prozora i ekrana aplikacija. Ovo se za web aplikacije može uradiri vršeći resize browsera dok se ne dobije vidljiv samo bitan deo, a tek onda skinuti sliku sa <Alt-PrtScr>. Dobro je potom u nekom editoru bitmap-a selektovati svu pozadinu, pa onda invertovati selekciju (odabrani deо slike - on se potom može i da po potrebi proširi za nekoliko piksela) i na kraju uraditi Crop.
Sadržaj teksta
Pravilno koristite izvore. Onaj koji ih koristi kako ne treba (videti i ovo) je plagijator. Ova praksa ima moralne, pravne i praktične posledice!
Obratiti pažnju na ton teksta koji mora biti jasan, tehnički i relativno formalan. Ne sme se koristiti prvo lice niti kolokvijalni ton: "možete primetiti", "Koliko nam je zaista ova tehnika pomogla i koliko nam je ona bitna...". Umesto "Kao što sam već napomenuo" bolje je "Kao što je objašnjeno u prethodnom odeljku" ili "U skladu sa zahtevima navedenim u sekciji 3.4".
U tekstu dati tumačenje novouvedenih ili manje poznatih pojmova ili skraćenica pri njihovom prvom korišćenju. Korišćene skraćenice ili manje poznati pojmovi mogu biti, uz alfabetsko sortiranje, dati u posebnom delu ili prilogu dokumenta.
Pažljivo eliminisati slovne i pravopisne greške. Ne sme se dozvoliti da mentor ispravlja banalne greške - ako program u kome se piše nema dobar spelling checker, tekst se može preneti u drugi softver i onda proveriti.
Ne praviti višestruke razmake ili razmake ispred interpunkcijskih znakova. Uvažiti činjenicu da u srpskoj latinici postoji slovo "đ". Pisanje VELIKIM SLOVIMA u načelu treba izbegavati. Nazivi i naslovi se na srpskom Nikada Ne Pišu Ovako, čak i ako su tako bili napisani na engleskom. Ne treba praviti višestruke razmake ili razmake ispred interpunkcijskih znakova, ali ih treba staviti iza interpunkcijskih znakova i između teksta i otvarajuće zagrade. Imati u vidu da postoje različiti otvarajući i zatvarajući navodnici i da u tekstu na srpskom oni izgledaju „ovako“, a u engleskom ovako: “that”.
Staviti u kurziv sve engleske fraze i reči koje nisu ušle u opšteprihvaćeni žargon. Izuzetak su skraćenice, ključne reči i identifikatori iz programskog koda. Izvodi iz koda ili strukturiranih sadržaja (konfiguracije, XML) i identifikatori treba da su u neproporcionalnom fontu. Ne menjati engleske reči direktno po padežima, već ih odvojiti crticom: beana -> bean-a.
Pisanje preglednog rada
Pregledni rad treba da opisuje pojmove i bitne aspekte teme, pristupe, aktivnosti i projekte u oblasti. Treba dati autentične rečenice i napor, makar u pretraživanju veba i inteligentnoj, i (ako je moguće) kritičkoj kompilaciji. Treba da se iskoristi to šta se nađe, ali ne da se prosto prevede ili ne otkrije originalni izvor. Autor treba da svojim rečima sublimira ono šta postoji nađenim izvorima (člancima, radovima, tekstovima na web-u, KoBSON-u...) uz jasno navođene izvora i referenci.
Pregled i sažetak aktuelnih dešavanja u okviru teme mogu biti u stilu "Pera je radio ovo, Mika ono, a to ima veze sa tim i tim sta je radio Laza, ali je prestao 2006-te. Ove aktivnosti se tematski razlikuju po: ...; metodološki ili po izvorima podataka: ...; ciljevi i primena su ..." itd.
Ne mora tu postojati neko jako izraženo mišljenje, mada autor ima puno pravo na njega i kada se susreće prvi put sa temom. Ne očekuje se da ovakva vrsta rada sadrži ikakve nove podatke, osim sistematizacija i agregacija koje autor napravi.
Smernice za kodiranje
Ako je GUI na engleskom, naslovi strana/prozora i tab-ova, toolbar, dugmići i linkovi koji glume dugmad treba da budu Title Capitalized, osim ako aplikacija već koristi drugu konvenciju. Samostalni linkovi, labele ispred polja, vrednosti u Select elementu, odnosno Dropdown kontroli i naslovi kolona treba da budu Sentence capitalized.
U editoru/IDE-u isključiti snimanje tab karaktera, i konsekventno koristiti indentaciju za 2-4 karaktera. Prema kontekstu konzistentno komentarisati na engleskom ili srpskom. Isto vazi za imena identifikatora koja treba da budu opisni i dugi, formirani po nekoj konvenciji, naPrimerOvako, KONSTANTE_OVAKO, AliNe_ovako. Za Java kod, pogledati http://java.sun.com/docs/codeconv/
Interakcija sa mentorom
Dobra je praksa da student pre početka implementacije napiše dokument kojim opisuje sadržaj rada/teme, odnosno zahtevanu funkcionalnost. Ovo treba sastaviti na osnovu ličnog viđenja sadržaja teme i utisaka dobijenih iz interakcije sa mentorom. Ovaj tekst će ionako postati deo konačnog rada, a omogućava da se sagledaju nedoumice, nerazumevanja i otvorena pitanja, kao i da se izbegnu lutanja, stranputice i promašaji pri implementaciji. Naravno, ovaj opis kasnije može biti proširen i ispravljen ukoliko se tokom implementacije došlo do dodatnih saznanja.
Treba poštovati opšte smernice i napomene koje je dao mentor (na primer, ove), kao i one koje se odnose na konkretne zadatke. Ipak, ako tu nešto nije jasno, bolje je pitati nego raditi uzalud ili promašiti temu. Gledati da se izbegne bombardovanje mentora brojnim verzijama rada, što je čest izraz želje se pronađe njegov prag tolerancije i uradi najmanje moguće, ili da on navede da ispravlja slovne i druge banalne greške, ili, još gore, proba da nađe smisao u neuređenom sirovom materijalu koji je student nabacao, pošto sam nije siguran o čemu piše ili ga jednostavno nije briga da to svoje pisanje malo organizuje. Ovo se može lako doživeti kao znak nepoštovanja i neuvažavanja tuđeg vremena.
Radne verzije dokumenta ne treba koričiti i štampati u boji.
Uvažavati naknadne napomene i ne provocirati mentora da vrši proveru da li su one uvažene ili stvarati potrebu da se već data napomena ponavlja. Posebno se ne sme potvrditi da je nešto urađeno ili ostaviti utisak da je urađeno, a da se to nije desilo, ili je urađeno nepotpuno ili sa greškom. Bolje je nešto prosto ne uraditi i reći (i napisati u dokumentu!) da to nije urađeno ili ispravljeno, te da bi na tome trebalo raditi. Tako će neki budući nastavljač znati gde da preuzme palicu.
Odbrana
Dokument treba pred odbranu dostaviti u 2+ primerka (za mentore i biblioteku). U dostavljene primerke je potrebno u digitalnom obliku, recimo na CD-u, dostaviti celokupni izvorni kod, dokument, prezentaciju, prateću dokumentaciju, backup korišćene baze, kao i druge potrebne resurse.
Za odbranu projekta ili diplomskog rada treba pripremiti 10-12 slajdova. Prezentacija traje oko 15 minuta, potom slede pitanja. Za master i magistarske teze ili doktorske disertacije ove cifre se okvirno množe sa 1.5, 2 ili 3.
Ostale napomene
I ovaj tekst bi se mogao organizovati prema gornjim smernicama, ali bi ga to učinilo manje praktičnim. Primena bilo kog unapred datog pravila ili preporučenog obrasca mora biti primerena nameni i obimu dokumenta i ciljnoj publici. Ovo, naravno, ne može biti izgovor za njihovo neopravdano kršenje, a posebno pravila pravopisa i akademskog poštenja - njih treba slediti poput zakona fizike!
