Warning
This page is located in archive.

Požadavky na zprávu

Technická zpráva je základní podklad k hodnocení vaší práce. Vy sice odevzdáváte i kódy (k nimž bývá přihlíženo) ale základem pro posouzení funkcionality je zpráva. Zpráva tedy musí mimo jiné prokázat, že jste úlohu splnili (tj. musí obsahovat požadované výsledky).

Základní struktura

  • Hlavička: název (včetně označení předmětu), autoři, datum.
  • Úvod popisující problém který se řeší.
  • Popis metody. Nejprve základní struktura celého řešení, pak vysvětlení dílčích kroků.
  • Výsledky. Netřeba v samostatné sekci, jednotlivé výsledky přímo k popisu jednotlivých kroků.
  • Zhodnocení, diskuze. Co se povedlo a co ne a proč, co by se dalo udělat jinak.

Srozumitelnost, jednoznačnost a přesnost

Hodnotíme, je-li popis vaší metody srozumitelný a jasný.

Obrázky. Každý obrázek musí obsahovat stručné vysvětlení co zobrazuje či co má čtenář vidět (nestačí že je v textu, kde může být také, a podrobnější). Popis obrázku musí rovněž obsahovat legendu (vysvětlení barev čar a podobně).

Reprodukovatelnost a průkaznost

Zpráva by měla být psána tak aby umožnila popisovanou práci zreprodukovat. Je třeba se při popisu soustředit na to, jaké metody a jak byly použity případně modifikovány. Pokud jste použili poskytované kódy, nezapomeňte to zmínit.

Dále je třeba zdokumentovat fakta a mezivýsledky a konečný výsledek. (Mezi)Výsledky rovněž musí demonstrovat správnost řešení. Snažte se ukázat (případně i jinými než požadovanými výsledky), že vaše výsledky jsou dobré. Uvědomte si, že hlavně pomocí zprávy prodáváte výsledek vaší práce.

V zásadě je tedy třeba spolu s popisem metody řešení uvést použité parametry, kvantitativní a kvalitativní výsledky (specifické pro každou úlohu).

Technická správnost

Prezentované výsledky stejně tak jako popisované postupy musí být samozřejmě správné.

Obsahová vyváženost

Zpráva má popisovat hlavně kreativní přínos autorů, nikoliv vysvětlovat základní metody. Nepíšete o tom, jak by se to dalo udělat, ale jak konkrétně jste tento jeden problém vyřešili vy.

Základní metody je třeba vhodně odkázat, jen je-li to nezbytné tak stručně připomenout. Text se pak musí soustředit na to, jak byly použity pro řešení konkrétního problému. Příliš podrobné zbytečné opisování základních algoritmů bude bodově penalizováno.

Také je třeba se vyhnout příliš podrobnému popisu implementace. Pište o použitých principech (např. x=argmax(f)), nikoli o tom, jak se jmenují vaše funkce které daný princip realizují, vyjadřujte se matematicky. Implementační detaily lze zmínit jen je-li to opodstatněné (např. lze říci, že výše uvedenou maximalizaci provádíte pomocí funkce fminsearch).

Styl

Hovorové, popularizující či žoviální zabarvení textu je nežádoucí. Výsledný text je technická zpráva nikoli beletrie. S výjimkou závěrečné diskuse se vyhněte spekulacím (Jak by se to dalo všelijak dělat…) ale pište o tom, co jste konkrétně udělali a co neudělali. Alternativy zmínit lze, pokud říkáte, kterou jste si vybrali a proč. Rovněž se vyhněte slangovým výrazům a dbejte na čistotu jazyka. Speciální obtížně přeložitelné anglické výrazy jsou povoleny (inliery, outliery), jinak samozřejmě používejte české ekvivalenty, jsou-li (např.: match → pár, korespondence).

(anglicko-český a česko-anglický slovníček počítačového vidění a jeho verze pro A5 brožurku)

Lze použít aktivní i pasivní styl, doporučujeme spíše aktivní v první osobě (Udělali jsme, Navrhli jsme, Zvolili jsme). Styl musí být konzistentní v celém textu.

Původnost a citace

Text musí být původní. Tvrzení a fakta, která nejsou výsledkem práce autorů, musí být vhodně odkázány. Je nepřípustné použít cizí práci prostým vložením bez souhlasu původního autora. Práci vašich kolegů samozřejmě použít nesmíte v žádném případě.

Formální požadavky na text

Zprávu odevzdejte ve formátu PDF. Zpráva musí mít formát stránky A4, velikost písma 11—12 bodů. Zpráva musí obsahovat body základní struktury. Nedělejte samostatnou titulní stránku.

Zpráva by měla být kultivovaně vysázena. Pokud si nejste jisti, stačí nahlédnout do nějakého odborného časopisu. Doporučujeme sazbu se zarovnáním do bloku, obrázky, tabulky a rovnice pak centrovaně.

Použité obrázky a tabulky musí být číslovány, opatřeny popiskem a odkazovány v textu. Doporučujeme číslovat rovněž i rovnice. Pokud se odkazujete na jiné zdroje (literatura a podobně), musíte je uvézt na konci v referencích. Zde ale smí být pouze reference skutečně použité v textu.

Gramatická správnost textu je samozřejmostí (tedy podmínkou nutnou, nikoli postačující). Použijte kontrolu pravopisu. Případné chyby typicky při čtení ruší a působí rozčilení a budou penalizovány.

courses/a4m33tz/cviceni/zprava.txt · Last modified: 2013/10/04 13:02 (external edit)