Nejčastější chyby

při psaní bakalářských a diplomových prací

Zde je uveden výčet nejčastějších chyb, kterých se autoři bakalářských a diplomových prací dopouští. Každý bod obsahuje název chyby, její popis a řešení a příklad dané chyby a její opravy. Většina těchto chyb je naprosto zbytečná a kazí autorovi hodnocení, i když je jeho realizační část práce na vysoké úrovni.

Textová část

Tato část zpravidla nevezme autorovi takové množství času jako část realizační, nicméně může zásadním způsobem ovlivnit výsledné hodnocení. Na tuto část je vhodné vyhradit si dostatečné množství času a je užitečné celý text dát k přečtení alespoň jednomu člověku mimo autora (kamarád, maminka,...). Gramatické chyby, překlepy a nesrozumitelné věty, které lze takto odhalit v opačném případě navozují dojem "odfláknuté" práce. Často je prezentace výsledného produktu důležitější, než jeho samotná kvalita (viz Horst Fuchs). Nebojte se také napsat zajímavé poděkování. Jedná se o jedinou část Vaší práce, kam můžete umístit vtípky a easter eggy! Je doporučeno používat vhodné nástroje jako například Overleaf pro usnadnění práce. Využití oficiální šablony a tvorba textu v Latexu je samozřejmost. Na začátku je dobré si pročíst obhájené a dobře hodnocené práce pro inspiraci. Také se může hodit si pročíst několik posudků, zejména od oponenta Vaší práce, abyste zjistili co jsou časté chyby.

Nevhodná struktura

Doporučené dělení textu je na 4 části: teorie, návrh, implementace a měření. Není nutné, aby práce obsahovala přímo kapitoly s těmito názvy, avšak toto členění by mělo být z textu patrné. Důvody jsou dva: 1. text popisuje postup autora (tedy nejprve je třeba nastudovat teorii, pak si rozmyslet jak to bude vypadat ve výsledku, pak začít programovat a zhodnotit výsledek), 2. usnadnit čtenáři čtení a pochopení textu. Někdy je obtížné návrh a implementaci oddělit. Návrh popisuje zejména jaké metody budou použity a jak budou propojeny. Častým problémem je chybějící téměř laický popis výsledku práce v úvodu a také podobný, ale podrobnější popis v návrhové části. Co jsou vstupy a výstupy? Čtenář je pak vržen do procesu řešení daného zadání bez informace, o čem vlastně celá práce je a co je očekávaným výsledkem. V návrhu je dobré umístit schéma popisující velmi jednoduše princip práce - takový trailer, na který se čtenář podívá a hned ví co že to ta práce řeší (vstupní data, bloky popisující jednotlivé fáze, výstupy). Implementace se zabývá problémy, na které autor narazil při programování, například ve spojení s danými knihovnami, jazykem, hardwarem apod. V implementaci může být klidně popsán i důvod odchýlení se od původního návrhu. Doplňující informace (datasety, podrobné výsledky měření, screenshoty...) se umísťují do příloh.

Nedodržení slohového útvaru

Jedná se o technickou zprávu odborného zaměření. Prvky vyprávění, úvah a fejetonů tento styl narušují. Nadměrné použití autorského plurálu či singuláru již svádí k vyprávění (lépe popisovat přímo problematiku a vyhnout se "já, my"), stejně jako oslovování čtenáře a pokládání řečnických otázek. Zrádné může být i střídání časů. Text popisuje existující věc a není příběhem, proto je optimální používat přítomný čas. Minulý a budoucí je vhodné používat velmi omezeně a jen v případě popisu skutečně časově vzdálených událostí. Je dobré se také řídit obecnými pravidly typografie a například rozlišovat mezi pomlčkou a spojovníkem apod.

Subjektivní zabarvení a nepodložená fakta

To, že si autor něco myslí ještě neznamená že to tak je. Veškeré výroky o dané problematice je nutné mít podložené relevantními zdroji.

V úvodech chybí popisy kapitol

Úvod celé práce by měl mimo nastínění problému také popisovat strukturu práce a konkrétních kapitol. Stejně tak nesmí chybět úvody ke kapitolám, kde se čtenář dozví o čem daná kapitola pojednává.

Absence vektorové grafiky

Co je možné tak sázet vektorově. Zejména jednoduchá schémata, grafy a tabulky.

Špatně

Správně

Krátké popisky obrázků

Text týkající se přímo obrázku je dobré přesunout do popisku tak, aby obrázek fungoval jako samostatný objekt a dával smysl i bez textu kde je odkazován.

Špatně

Zařízení na obrázku 2.2 slouží k cestování vesmírem...

Obrázek 2.2: Hvězdná brána

Správně

...zařízení (obrázek 2.2).

Obrázek 2.2: Hvězdná brána, zařízení sloužící k cestování vesmírem....

Chybějící reference

Všechny objekty (obrázky, algoritmy, grafy, rovnice) musí být referencovány z textu a být označeny číslem (pro kontrolu existuje package refcheck). Samotný odkaz by měl obsahovat mimo číslo i typ objektu (ne jen číslo samotné). Mezi typem a číslem by měla být nezalomitelná mezera, aby odkaz nebyl rozdělen na konci řádku.

Rovnice jako text

Rovnice vždy sázet v k tomu určeném prostředí. Označit skaláry a vektory a používat také správně symboly jako tečku při násobení namísto hvězdičky. Závorky by měly výškou odpovídat obsahu (například pokud je v závorkách zlomek tak dané závorky budou stejně vysoké).

Správně

Zdrojový kód jako text či obrázek

Názvy proměnných odlišit fontem a části kódů (raději však kratší pseudokódy než přímo vykopírované části) vkládat jako objekty. Pro sázení kódu použijte speciální prostředí, které daný nástroj nabízí.

Špatně

Proměnná alpha pak značí...

NEBO

...lze popsat kódem na obrázku 1.1

Obrázek 1.1: Kód FPS limiteru

1 while(!end)
2  begin = currentTime()
3  simulation.step()
4  gpu.render()
5  end = currentTime()
6  frameTime = end-begin
7  if(frameTime < stepTime)
8    sleep(stepTime-frameTime)

Pseudokód jako zdrojový kód

Při popisu algoritmu je dobré použít pseudokód a využít všech typografických pomůcek a zjednodušení pro dobrou čitelnost. Pseudokód by neměl být vykopírováním kusu kódu ze zdrojových souborů a nemusí být kompilovatelný. Také nemusí popisovat konkrétní implementační detaily, pokud to není nutné. Je také vhodné algoritmus popsat a definovat vstupy a výstupy.

1 float average = 0;
2 for(int i=0; i<elements.getSize(); i++)
3 {
4	average += elements[i];
5 }
6 average /= elements.getSize();
7 for(int j=0; j<elements.getSize(); j++)
8 {
9	std::cout << std::fixed;
10	std::cout << std::setprecision(2);
11	std::cout << power(average-elements[j],2) << std::endl;
12{

VSTUP: elements - pole elementů
VÝSTUP: seznam upravených elementů na obrazovce 
1 foreach(element in elements)
2 	printLine( (elementsaverage-element)2 )

Reference na zdroj jako předmět a na nesprávném místě

Reference na zdroje je třeba vždy umístit co nejblíže citovanému místu a používat je jako metadata, tedy ne jako součást textu. Reference však patří do citované věty, ne až za čárku či tečku. Reference udává zdroj informace, která je vlastními slovy uvedena a zasazena do kontextu práce. V případě přímého vykopírování části textu z cizího díla (i v případě doslovného překladu) je nutné celou tuto část označit například uvozovkami či kurzívou a jasně tak vyznačit, že se jedná o přímou citaci. Takové citace však nejsou nástrojem pro prodloužení textu, jelikož se nepočítají jako originální obsah autora. V případě, že je například celá sekce inspirována jistým zdrojem tak je možné uvést tuto skutečnost větou jako Tato sekce čerpá informace z článku....[x]. Na konci je dobré projít výsledné PDF a vyhledat zda někde nejsou špatné citace, vysázené jako [?].

Nevhodně zvolené překlady

Pokud existuje obecně používaný český ekvivalent slova tak zbytečně nepoužívat anglické výrazy. Pokud však takový ekvivalent není tak se nesnažit vytvářet vlastní české verze.

Nadpisy třetí úrovně v obsahu

Obsah je v takovém případě nepřehledný a zbytečně dlouhý.

Neslabičné předložky na konci řádku

Takové předložky patří na řádek s následujícím slovem. Pro LaTeX existuje nástroj Vlna, který řeší tento problém automaticky.

Malé velikosti textů, podobné barvy křivek a chybějící popisy os s jednotkami u grafů

Při tisku pak jsou texty nečitelné a křivky nerozeznatelné. Je nutné vložit informace nutné k pochopení a správné interpretaci grafů a tabulek ale také odstranit zbytečné elementy.

Špatně

Správně

Tabulky a text namísto grafů

Velké tabulky s daty nevypovídají na první pohled nic o zjištěných poznatcích. Lépe nahradit grafem, kde čtenář hned vidí co z měření vyplývá (přesná data mohou být například v příloze). Stejně tak lépe výsledek vyjádřit grafem a pár větami, než se snažit celým odstavcem popsat jeho význam. (Jeden obraz vydá za tisíc slov. - Čínské přísloví)

Správně

Graf 5.5: Hodnoty zkoumaných veličin v jednotlivých framech. Ve framech 0 a 6 je rozdíl mezi nimi příliš velký a veličiny zde nekorelují.

Krátké odstavce a kapitoly

Kapitola by měla být alespoň několik stran dlouhá a odstavec o jedné větě také není ideální. Často lze tématicky příbuzné části textu sloučit, avšak vhodné dělení je třeba zachovat.

Příliš složité a nepochopitelné souvětí

Někdy je lepší rozdělit souvětí na jednoduché věty. V případě moc dlouhých vět pak čtenář dojde na konec dané věty a často již neví co bylo na začátku. Také moc závorek a lomítek ve větách zhoršuje jejich čitelnost. Ve zdrojovém kóduje doporučeno pro lepší čitelnost a přehled pro autora psát každou větu na nový řádek (v Latexu se ve výsledném PDF nijak neprojeví).

Přepis dokumentace použitých nástrojů

Je podezřelé, když je polovina celé práce zaměřena pouze na popis vývojářského prostředí či nástrojů, která autor využívá ale nejsou jeho dílem. Práce nemá zastupovat většinou volně dostupnou dokumentaci daných nástrojů.

Nedefinované zkratky a pojmy

Pokud se v práci vyskytuje specifický pojem či zkratka, kterou čtenář nemusí znát pokud se o danou problematiku nezajímá, tak je třeba při prvním výskytu vysvětlit, nejlépe již v teorii či dále v textu, nebo jako poznámku pod čarou. Stejně tak je nutné popsat veškeré použité proměnné a názvy použité v rovnicích či jiných objektech.

Drobné typografické chyby

Velké množství typografických anomálií může způsobit, že text bude na pohled vypadat jako práce studenta druhého stupně základní školy. Je dobré seznámit se se všemi možnostmi sázení daného nástroje, zejména když jde o speciální znaky. Také je na místě nastudovat kde se správně dělají mezery apod. v rámci použitého jazyka. Dodržovat mezery před citačními závorkami, citace sázet do vět a ne za, nedávat mezery před odkazy na poznámky pod čarou, umístit odkaz a danou poznámku na stejnou stranu, nemít dva nadpisy pod sebou bez textu, nekončit řádky předložkama a spojkama, nemít příliš volného místa v obrázcích, atd.

Chybějící či špatně umístěné zdroje obrázků

Musí být přítomný zdroj převzatých obrázků, ne však formou url v popisku ale například poznámkou pod čarou. Uvádění url může být samo o sobě také nebezpečné, jelikož se odkazy mohou časem stát nefunkčními.

Špatně

Obrázek 4.2: Plakát filmu Dračí srdce. Převzato z https://www.imdb.com/title/tt0116136/

Správně

Obrázek 4.2: Plakát filmu Dračí srdce.¹

...

___________________________

1 Převzato z IMDb.com (Internet Movie Database) - Profil filmu DragonHeart (1996): http://...

Obrázky pro natažení textu

Nic neříkající obrázky, které nepopisují Vaše řešení jsou zbytečné a naznačují, že autor se snaží jen zvýšit počet stran.

Špatně

Obrázek 4.5: Hra

Nečitelné obrázky

Obrázky musí být čitelné a jasné i v tištěné podobě. Při čtení elektronické verze by čtenář neměl být nucen si obrázky přibližovat. Při tvorbě screenshotů apod. je třeba se zamyslet nad tím, co je skutečně důležité zobrazit. Špatným indikátorem je fakt, kdy většina obrázku je prázdné pozadí. Když je to možné, je lepší dávat screenshoty se světlým designem aplikací místo tmavého, v případě kdy je to možné dokonce ořezat obraz a dát bílé pozadí kde to jde, nebo vyříznout jen objekt zájmu od zbytečností okolo.

Špatně

Správně

NEBO LÉPE

NEBO JEŠTĚ LÉPE

NEBO NEJLÉPE

Citace z nekvalitních zdrojů

Vždy dávat přednost vědeckým článkům a odborné literatuře před populárně naučnými články a nadšeneckými blogy. Necitovat z Wikipedie. Pokud jde o obecně známé pojmy tak není třeba citovat, případně se odkazovat například na nějakou uznávanou učebnici. Pro vyhledání zdrojů a vygenerování citací by měl stačit Google Scholar (někdy mohou být citace neúplné a je vhodné doplnit z webu kde je např. článek publikován). Tutoriály na Youtube, weby společností, reklamní weby produktů, Github repozitáře s použitými knihovnami apod. patří do poznámek pod čarou a ne do seznamu literatury.

Vícenásobné reference na stejný zdroj

Reference na stejný zdroj není třeba dělit podle sekcí. Stačí citovat celý zdroj, případně použít rozšířené odkazy, kde vedle čísla zdroje bude ještě strana případně sekce.

Barvy

Nebojte se používat barvy pro lepší odlišení jednotlivých vrstev či dat v grafech a obrázcích. Ideálně si vyberte jedno barevné téma pro celou práci a používejte stejnou paletu ve veškeré grafice. Práce pak bude vypadat profi!

Špatně

Správně

Nekonzistentní značení

Stejně jako u programování je více než použitá norma důležitější konzistence v rámci projektu, i v textu platí toto pravidlo. Veškeré speciality jako značení jistých pojmů jiným typem písma, pojmenování velkým počátečním písmenem, formát popisků objektů v textu či referencování zdrojů, to vše by mělo být v textu dodržováno ve stejném stylu.

Implementace

Cílem je, aby překlad a spuštění výsledku bylo jednoduché pro Vás i oponenta či další případné uživatele. Proto je doporučeno používat moderní nástroje jako Git pro správu projektu. Pokud se jedná o zajímavý projekt tak je vždy dobré zveřejnit po dokončení pro další lidi například na serveru GitHub, nebo na jiných platformách. Dále pro usnadnění překladů je vhodné vytvořit pomocné skripty, například pro stažení závislostí, odevzdat také již zkompilované soubory či využít nástroje jako je CMake.

Chaotický kód

Kód nemusí nutně být za každým řádkem komentovaný (ideálně by měl být psaný tak, aby komentáře nepotřeboval a byl pochopitelný), nicméně měl by být přehledný, vhodně rozdělen do souborů a autor by měl využívat moderních postupů daného programovacího jazyka. Viz Clean Code.

int main( int argc, const char* argv[] )
{
	//initialiying library
	initLibrary(3141592);
	startSimulation(argv[2]);
	...
	//do it 10 times
	while ( i < 10 )
	{
		i++;
		printf( "Idk %d\n", i );
	}
	if(x<5)
		exit();
	//toto musim opravit 
	goto hell;
	...
}
   

int main( int argc, const char* argv[] )
{
	Simulation simulation(MAX_STEP_COUNT);
	try 
	{
		simulation.run()
	}
	catch (std::exception e) 
	{
		std::cerr << e.what();
		return EXIT_FAILURE;
	}
	return EXIT_SUCCESS;
}
   

Neoznačený převzatý kód

Každý převzatý kus kódu musí být jasně označen s uvedením zdroje. Ideálně je vhodné tak učinit přímo v kódu formou komentáře, zmínit tuto skutečnost v textové zprávě, a ještě přidat soubor shrnující kde jsou tyto části. Výskyt necitovaného kódu z třetí strany je velmi závažný přestupek a práci je pak nutné považovat za plagiát. V případě tutoriálů lze považovat volně přepsaný kód za originální, pokud se nejedná o čistou kopii. Není ostuda a je bezpečnější označit takové části jako inspirované daným zdrojem.

int superFunctionThatIDontEvenUnderstand()
{
	...
}
   

//This whole function was taken from ....
int superFunctionThatIDontEvenUnderstand()
{
	...
}
   

Obhajoby

Na Vašem projevu u samotné obhajoby záleží! Komise rozhoduje o Vašem titulu, proto dojem který student udělá hraje velkou roli v úspěšnosti při obhajobách ať je jeho aplikace jakkoliv dobrá či špatná.

Nečitelné, příliš kontrastní slidy a strohý design

V první řadě musí být vše na prezentaci čitelné i z dálky, tedy dostatečně velké. Tmavé písmo na tmavém pozadí v kombinaci se starým projektorem a nevhodným osvětlením místnosti může z celé prezentace učinit nečitelný šum. Pozor však aby barevná kombinace textu a pozadí nedráždila oči (nekombinovat např. #000000 a #ffffff, moc kontrastní). Šablona a barevné schéma by mělo zaujmout, proto se nebojte vlastního designu namísto známých šablon které posluchače automaticky nutí očekávat nudnou přednášku. V šabloně nesmí chybět čísla slidů a celkový počet (aby komise věděla kolik času Vám to ještě asi zabere).

Špatně

Správně

Text

Ideálně by slidy neměly obsahovat žádný text mimo nadpisy. Prezentace slouží jako vizuální podpora Vašeho ústního výkladu, není to nápověda co máte číst (používat obrázky, schémata, grafy). Je zbytečné, aby posluchač četl to stejné co Vy říkáte. Videa je vhodné umístit přímo do prezentace (ideálně jako gif). V případě PDF je možné i bokem a ukázat na konci. Složité algoritmy lépe ukazovat na animacích, například inkrementovat průběh po jednotlivých slidech. Zhodnoťte kolik místa na slidu je prázdného, pár odrážek na poloprázdné stránce působí jako zbytečný slide.

Špatně

Správně

První a poslední slide

Na první slide klidně vložte obrázky z výsledků Vaší práce a stejně tak na slide poslední namísto profláklého "Děkuji za pozornost". U posledního slidu se prezentace na konci zastaví a tam bude probíhat diskuze. Pokud na pozadí poběží Vaše krásné demo tak komise jistě přijme Vaše odpovědi s větším nadšením. Na úvodním slidu uvést Vaše jméno, název práce a jméno vedoucího.

Špatně

Správně

Zahlcení informacemi

Na slidech by neměly být věci, které divákovi zaberou dlouhý čas pro pochopení. Zaprvé z toho bude divák deprimovaný, že nerozumí a zadruhé Vás přestane během přemýšlení poslouchat. Snažte se odolat pokušení "zamachrovat" a ukázat všechny ty složité rovnice a schémata co v práci používáte. Naopak vytvořte jednoduché vysvětlení problému tak, aby se divák nemusel zabývat složitými postupy, ale věděl co jste použili a jak to přispívá k výsledku. Zmiňte však všechny zajímavé použité algoritmy, tvořící jádro Vaší práce aby práce nepůsobila jako "naklikané" demo, ale aby bylo jasné, že řeší netriviální problémy.

Špatně

Správně

Celkový dojem

Do prezentace na konec umístit věci potřebné pro odpovědi na otázky oponenta abyste nemuseli přepínat mezi prezentacemi. Slidy seřadit tak, abyste nemuseli skákat zpět. Obhajoba je poměrně krátká, proto není třeba popisovat detaily, pouze vyzdvihnout nejlepší věci a jednoduše je vysvětlit. Na slidech zvýrazněte důležité věci ať minimalizujete nutnost ukazovat na plátno. Během prezentace je také dobré udržovat oční kontakt s posluchači, ne s projekčním plátnem a mluvit nahlas. Uvědomte si, že posluchači nemusí znát problematiku Vaší práce, proto na začátku vždy popsat co řešíte, co je na vstupu a na výstupu vašeho algoritmu/aplikace a až poté popisovat řešení. Odříkání si prezentace doma před zrcadlem a před maminkou je samozřejmost. Přetažení stanoveného času na prezentaci není tolerováno.

Ostatní

Zbytečná data na přiloženém médiu

CD/DVD/SD karta by měla obsahovat zdrojové kódy, potřebná další data pro spuštění aplikace, readme, dodatečné soubory dle zadání (video, plakát), elektronickou verzi textové části a její zdrojové kódy. Může dále obsahovat například přeloženou aplikaci, datasety, nebo výsledky měření. Nepřikládat soubory vzniklé během překladu, logy, cache soubory atd. Ideálně existuje na médiu skript či je použit nástroj CMake pro snadný překlad na různých platformách. Adresářová struktura by měla být jednoduchá a jasná.

Zdrženlivost při konzultacích a komunikaci s oponentem

Nebojte se vedoucího ptát a konzultovat částí práce, kde si nejste jistí. Na konzultace je vhodné chodit pravidelně a náležitě připraven (projeví se v posudku vedoucího). Hlavní problém je často myšlenka studentů Ale já nic neudělal/a od minula, to bude trapná konzultace! Komunikace s vedoucím je důležitá jelikož může poradit jak zachránit práci když teče do bot. Hlavní je komunikovat za každou cenu! Pokud Vaše práce využívá speciálních technologií či máte obavu, že by oponent mohl přehlédnout důležité aspekty Vašeho díla, neváhejte oponenta kontaktovat a případně se s ním domluvit na demonstraci práce.

Správně

Málo času

K tomuto problému dojde vždy. Blíží se termíny půlsemestrálek, zkoušek, projektů a do toho práce. Jediné řešení je organizace. Nemusí se jednat o tabulky a plánované rozvrhy. Stačí když si student vyhradí třeba minimálně půl hodiny každý den na práci na BP/DP. Ne však až před koncem semestru, až bude čas. Ten čas nebude! Důležitá je konzistence. Při správné a postupné práci se lze celkem jednoduše vyhnout spánkové deprivaci a nadměrnému stresu. V případě souběžného zaměstnání může být situace komplikovaná, proto je doporučeno buď se v posledních ročnících věnovat pouze škole, nebo minimálně domluvit si snížení úvazku (Já bych teda FIT s prací nedal ani za nic! :D).