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. 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. Uvod i zaključak se obično ne numerišu brojevima. 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, 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, što rasterećuje osnovni uvod. Glavno telo teksta treba da generalno bude u skladu sa sledećom strukturom <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 # 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 # Results - Usability evaluation and/or comparison with the reference, features through description of system appearance, snapshots, # Discussion - What is presented, focus areas during problem solving, usability, addressed problems, possible improvements, what is learned, benefits and impact of the new system </i> Ne zaboraviti opisati i razvojno/radno okruženje. Posle glavnog tela slede <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 # Acknowledgments - Institutions, persons, grants. # References </i> Zaključak za diplomski mora imati bar jednu stranu, za 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. Reference (literatura) moraju biti zaista i koiršćene, odnosno referencirane u prethodnom tekstu. Na samom kraju se mogu, po potrebi, dodati i prilozi. = Tehnička priprema i format dokumenta = Ne postoji zvanični templejti 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. Radne verzije dokumenta ne treba koričiti i štampati u boji. Slike i tabele treba da imaju potpis i da budu referencirane u tekstu. Slike treba da budu jasne, uredne i funkcionalne, blizu mesta gde se opisuju ili referenciraju. Treba da imaju svetlu (najbolje belu) pozadinu i da efikasno koriste prostor dokumenta. Treba ukloniti suvišne beline iz prikaza sadržaja prozora i ekrana aplikacija. To se može uradiri vršeći resize browsera dok se ne dobije vidljiv samo bitan deo, a tek onda da raditi Alt-PrtScr. Dobro je potom u nekom editoru bitmap-a selektovati svu pozadinu, pa da se onda invertuje selekcija (i eventualno prosiri za nekoliko piksela) i na kraju uradi crop. Oznake i brojevi poglavlja, sekcija, slika, tabela, referenci i referenci na reference treba da se automatski numerišu koristeći <i>cross-reference</i>, 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 ... a ne ... 5 Zaključak 5.1 ... ... 6. Reference 7. Prilozi 7.1 Prilog A Reference treba da su zaista referencirane u tekstu i jednoznačne (za dokumenta na internetu URL, za knjige moraju biti prisutni izdavač i godina, za članke i naziv časopisa/izdanja i strane). U tekstu dati tumačenje novouvedenih ili manje poznatih pojmova ili skraćenica pri njihovom prvom korišćenju. 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. 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 u načelu treba izbegavati. Staviti razmake iza interpunkcijskih znakova. 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. 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. = 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 potrebnu funkcionalnost. Ovo treba sastaviti na osnovu definisanog sadržaja teme i 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. Uvažavati napomene i ne provocirati mentora da vrši proveru da li su napomene uvažene ili stvarati potrebu da već data napomena ponavlja. Posebno ne potvrditi da je nešto urađeno ili ostaviti utisak da je urađeno, a to se nije desilo, ili je urađeno nepotpuno ili sa greškom. Svi grešimo, ali bolje nešto prosto ne uraditi i reci (i u dokumentu!) da nije urađeno i da bi na tome trebalo raditi, da bi nastavljač znao 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 treba pripremiti 10-tak slajdova. Prezentacija traje 20-ak minuta, potom slede pitanja. Za magistarske teze ili doktorske disertacije ove cifre se okvirno množe sa 2 i 3. = Ostale napomene = I ovaj tekst bi se mogao organizovati prema gornjim smernicama :)

Return to Smernice za pripremu tehničkog rada.