Smernice za pripremu tehničkog rada
From RCUB
(→Sadržaj teksta) |
|||
| Line 6: | Line 6: | ||
Pre uvoda ide sadržaj: poglavlja i odeljci, eventualni spisak (indeks) tabela i spisak slika. | 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 | + | 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 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. | + | 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: | 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: | ||
| Line 42: | Line 42: | ||
== Numeracija == | == Numeracija == | ||
| − | Strane, osim naslovne, moraju biti numerisane. Do prve strane prvog poglavlja stanice su numerisane rimskim brojevima (i, ii, iii...), a | + | 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...) | stranice su numerisane arapskim brojevima (1, 2, 3...) | ||
| Line 71: | Line 71: | ||
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. | 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. | + | 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 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 dokumente 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 veb stranice). Linkovi koju ukazuju 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 == | ||
| Line 77: | Line 77: | ||
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 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 | + | 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 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 <i>Crop</i>. |
== Sadržaj teksta == | == Sadržaj teksta == | ||
| Line 83: | Line 83: | ||
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". | 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. | + | 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 sme se dozvoliti da | + | 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 <i>spelling checker</i>, 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. | 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. | ||
| − | 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 | + | 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 -> <i>bean</i>-a. |
= Pisanje preglednog rada = | = 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 | + | 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, 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. | 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. | ||
| Line 109: | Line 109: | ||
= Interakcija sa mentorom = | = Interakcija sa mentorom = | ||
| − | Dobra je praksa da student pre početka implementacije napiše | + | 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 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. | 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. | ||
