View source

= Uvod = Ove smernice su primenljive na pripremu članka, projekta, seminarskog i diplomskog rada, magistarske teze ili doktorske disertacije. = Osnovna struktura dokumenta = 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 diretno projektovati na značaj samog rada, i tu vezu treba pažljivo postaviti. Uvod za diplomski bar na 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 <i>(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)</i> * Postupak rešavanja <i>(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)</i> * Opis rezultata ili realizovanog rešenja <i>(Results - Usability evaluation and/or comparison with the reference (i.e. initial approach), features through description of system appearance, snapshots, usage description)</i> * Analiza rezultata <i>(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)</i> 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 <i>(Conclusions - Long term objective/goal, what is done (chronologically or following the data flow), introduced concepts, usability of applied concept or implemented solution, impact)</i> * Zahvalnice <i>( Acknowledgments - Institutions, persons, grants)</i> * Reference <i>(References)</i> 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 == Ne postoji zvanični obrasci za radove, teze i disertacije. Poželjno je bude pisan u MS Word-u ili OpenOffice-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 <i>bullet</i>-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. Pasusi tela teksta treba da su ujedeni u prvom redu i/ili međusobno razmaknuti za pola reda. == Numeracija == Strane, osim naslovne, moraju biti numerisane. Do prve strane prvog poglavlja stanice su numerisane rimskim brojevima (i, ii, iii...), a od 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 <i>cross-reference</i> 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 == Reference (literatura) treba da su zaista korišćene, odnosno referencirane u prethodnom tekstu koristeći razmak i uglaste zagrade. One se mogu koristiti kao element rečenice (na primer, "[ABa, ZD05] analiziraju ovaj problem, koji se još ponegde pominje [XY08]."), a mogu se i, poput fusnota, ignorisati u samom toku 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 moraju biti 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 prepričavanje. Ukoliko se referenca koristi oda 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. Regerence moraju jednoznačno da imenuju izvor i ukažu gde se izvorni dokumnt može naći. 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 dokumenta na internetu treba 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 web stranice). Linkovi koju ukazuji na neku opštu stranicu kao što je http://www.wikipedia.org/ su potpuno bespredmetni - referenca moraju da ukazuje na konkretan izvor korišćene informacije. == Slike == Slike i tabele treba da imaju potpis i da budu referencirane u tekstu. 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. Slike treba da budu jasne, 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 njehovog kopirajta, ili klasičnim referenciranjem dokumenta ili URL-a odekle 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 &lt;Alt-PrtScr&gt;. Dobro je potom u nekom editoru bitmap-a selektovati svu pozadinu, pa da se onda invertuje selekcija (odabrani deо slike - on potom može i da po potrebi proširi za nekoliko piksela) i na kraju uradi <i>Crop</i>. == Sadržaj teksta == Obratiti pažnju na ton teksta koji mora biti jasan, tehnički i relativno formalan. Ne sme se koristiti prvo lice niti kolokvijalni ton: 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 greške, 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. Staviti razmake iza interpunkcijskih znakova i izneđu teksta i otvarajuće zagrade. Staviti u kurziv sve engleske fraze i reči koje nisu ušle u opšteprihvaćeni žargon. Izuzetak su ključne reči, skraćenice i identifikatori iz koda. Segmenti i izvodi iz koda i identifikatori treba da su u neproporcionalnom fontu. Ne menjati engleske reči direktno po padežima, već ih odvojiti crticom: beana -> <i>bean</i>-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 web-a 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, Kobsonu...) 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 dukument kojim opisuje sadršaj rada/teme, odnosno zahtevanu funkcionalnost. Ovo treba sastaviti na osnovu ličnog viđenja sadržaja teme i utisaka ainterakcije 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 oseti 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 jednostavo 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 :)

Return to Smernice za pripremu tehničkog rada.