KATEDRA INFORMATIKY UNIVERZITA PALACKÉHO MARTIN DOSTÁL VÝVOJ TOHOTO UČEBNÍHO TEXTU JE SPOLUFINANCOVÁN

Transkript

1 KATEDRA INFORMATIKY PŘÍRODOVĚDECKÁ FAKULTA UNIVERZITA PALACKÉHO PRŮVODCE BAKALÁŘSKOU PRACÍ MARTIN DOSTÁL VÝVOJ TOHOTO UČEBNÍHO TEXTU JE SPOLUFINANCOVÁN EVROPSKÝM SOCIÁLNÍM FONDEM A STÁTNÍM ROZPOČTEM ČESKÉ REPUBLIKY Olomouc 2007

2 Abstrakt Tento text je stručným a praktickým průvodcem diplomanta při tvorbě bakalářské práce. Čtenář se seznámí se zásadami pro vypracování bakalářské práce, průběhem hodnocení a obhajoby. Text obsahuje také základy práce s typografickým systémem L A TEX. Stručně je probrána problematika přípravy prezentací. Cílová skupina Učební text je určen posluchačům studijního oboru Aplikovaná informatika v kombinované formě vyučovaného na katedře informatiky PřF UP v Olomouci.

3 Obsah 1 Bakalářská práce Etapy bakalářské práce Struktura bakalářské práce Obhajoba Před obhajobou Průběh obhajoby Tvorba odborné části práce Přehledová část Použité technologie Rozbor architektury aplikace, struktury kódu a dynamiky aplikace Datová základna aplikace Instalátor aplikace Bezpečnost Standardy Testování aplikace Pár poznámek k sazbě Jazyk práce Práce zaměřená na hardware Práce zaměřená na počítačovou hru Tvorba uživatelské dokumentace Struktura uživatelské dokumentace Pracovní scénáře Sazba textu práce v typografickém systému TEX s balíkem maker L A TEX Základy Struktura souboru Překlad souboru Základy sazby textu Mezislovní mezery Dělení slov Sazba uvozovek Sazba pomlček, teček a podobných znaků Výpustky v textu Druhy a velikost písma Strukturování textu Křížové odkazy Poznámky pod čarou

4 5.9 Prostředí v L A TEXu Výčty Zarovnávání textu Přímý výstup textu Sazba tabulek Vkládání obrázků Plovoucí objekty Definice nových příkazů a nových prostředí Sazba matematických výrazů Sazba seznamu literatury a citace Jak na prezentaci A Vzor titulních stran

5 Toto Stavjetextu pracovní a nedokončená verze učebního textu Průvodce bakalářskou prací. neprošlo jazykovou korekturou 5

6 6 Úvod Tento učební text slouží jako praktický průvodce při tvorbě bakalářské práce. Text obsahuje několik na sobě nezávislých témat, která mohou být při tvorbě závěrečné práce užitečná. Jednotlivé kapitoly postihují základy dané problematiky a v žádném případě si nečiní nároky na úplnost. První kapitola podává základní informace o bakalářské práci, její struktuře, etapách a právním postavení. Druhá kapitola seznamuje čtenáře s průběhem obhajoby bakalářské práce a s tím, co obhajobě samotné předchází. Třetí a čtvrtá kapitola uvádí souhrn zásad pro vypravování odborné části práce, přičemž čtvrtá kapitola je věnována problematice tvorby dokumentace software. Pátá kapitola seznámí čtenáře se základy sazby dokumentů v typografickém systému L A TEX. Šestá, poslední, kapitola je zaměřena na přípravu prezentace během obhajoby.

7 7 1 Bakalářská práce Bakalářská práce je závěrečnou prací studenta. Osvědčuje jeho odbornou úroveň a schopnost zpracovat zadanou problematiku odborně správným způsobem a její výsledky uceleně formulovat v bakalářské práci. Téma práce si student vybírá ze seznamu témat, která vypisují jednotliví akademičtí pracovníci. Druhou možností je navrhnout téma vlastní. Při této variantě si student musí najít vhodného vedoucího práce, který návrh posoudí a připraví zadání. Zadání práce musí obsahovat, kromě tématu, jasnou formulací cílů práce a nároků na ni kladených. Při úvaze o výběru tématu je dobré si položit tyto otázky: Čím je téma pro mě zajímavé? Jaký bude význam práce a čeho chci dosáhnout? Jaký bude přínos práce? Jsem schopen téma odborně zvládnout? Je téma pokryto potřebnou literaturou? Při výběru tématu je rozumné zvážit své dosavadní zkušenosti, protože by se mohly při volbě vhodného tématu dobře využít. Diplomovou práci je také dobré brát tak trochu jako výzvu není nutné, abyste problematiku před volbou tématu ovládali, během práce můžete mnoho nových a pro vás přínosných věcí nastudovat. Přesné podmínky pro zadání, vypracování, odevzdání, obhajobu a zveřejňování bakalářských prací na katedře informatiky upravují předpisy univerzity, fakulty a katedry. Tyto předpisy stanovují nejen povinnosti, ale i práva diplomanta a dalších osob podílejících se na bakalářské práci a souvisejících činnostech. Proto je dobré se s těmito předpisy náležitě seznámit. Bakalářská práce je autorským dílem a je podobně jako ostatní taková díla chráněna zákonem 121/2000 Sb. o právu autorském, o právech souvisejících s právem autorským a o změně některých zákonů (tzv. autorský zákon ) [5]. V případě bakalářské práce je jedná o takzvané dílo školní a jeho režim upravuje 60 zákona. Z 60 zákona vyplývá právo školy na uzavření licenční smlouvy s autorem díla za účelem užití školního díla a to za obvyklých podmínek. Obvyklými podmínkami se zřejmě rozumí například bezplatné použití díla pro účely související s činností školy. Pokud by škola chtěla využít dílo autora k výdělečným účelům nárok autora na odměnu není nijak dotčen. V případě, že autor odmítne se školou uzavřít licenční smlouvu, může se škola domáhat uzavření licenční smlouvy soudní cestou. Autor může své dílo užít, nebo také poskytnout jinému licenci pro jeho užití, není-li však v licenční smlouvě se školou sjednáno jinak a není-li to v rozporu s oprávněnými zájmy školy. V případě, že autor školní dílo použije k účelům z nichž mu plyne zisk, pak má škola právo se domáhat přiměřené úhrady nákladů (až do jejich plné výše), které byly na vytvoření díla z prostředků školy vynaloženy. Příkladem takové situace může být třeba software, který vznikl jako součást bakalářské práce a zaměstnavatel autora má zájem o úplatné užití tohoto díla. V tomto případě má škola právo domáhat se přiměřené úhrady svých nákladů. 1.1 Etapy bakalářské práce Výběr tématu Témata prací jsou zveřejňována podle příslušného předpisu. Student si bud některé z témat vybere, nebo může navrhnout téma vlastní (k tomu

8 8 má právo podle 62 zákona 111/1998 Sb., tzv vysokoškolský zákon ). Témata vypisují jednotliví akademičtí pracovníci, kteří pak vystupují jako vedoucí práce. Formulace zadání Vedoucí práce připraví studentovi zadání, které stručně formuluje obsah a cíl práce. Zadání práce je důležitým dokumentem při hodnocení práce, jelikož jedním z hlavních kritérií, je zda a do jaké míry diplomant splnil zadání. Vypracování práce Společně se zadáním práce je studentovi přidělen vedoucí práce, což je akademický pracovník, který studenta vede při tvorbě bakalářské práce a poskytuje konzultace. Vedoucí práce však není jejím spoluautorem, diplomat tedy nemůže očekávat od vedoucího, že za něj vyřeší všechny problémy se kterými si diplomant neví rady. Konzultace s vedoucím bakalářské práce by měly probíhat průběžně. Vedoucí práce zejména diskutuje s diplomatem o problémech, doporučuje postup a literaturu. Diplomant by se měl na každou konzultaci předem připravit a promyslet si otázky na vedoucího práce. Není korektní očekávat, že váš vedoucí bude provádět jazykovou korekturu práce nebo že bude testerem vaší aplikace. Předkládat text plný gramatických a stylistických chyb dobře vypovídá o úrovni a přístupu diplomanta. Může se stát, že diplomant se s vedoucím v některých otázkách neshodne. Je vždy na uvážení diplomanta, zda se bude či nebude řídit doporučeními vedoucího. Odevzdání práce Práce se odevzdává podle pokynů uveřejněných v příslušném předpisu, zejména postup odevzdání, termíny a podobně. Těchto pokynů je třeba striktně dbát, nebot jejich nedodržení může být důvodem pro nepřipuštění k obhajobě. Posudek vedoucího a oponenta na práci Odevzdaná práce je hodnocena posudky, které vypracují vedoucí práce a oponent práce. Oponenta práce jmenuje osoba určená příslušným předpisem. Posudek hodnotí zejména postup při řešení, dosažené výsledky a prezentaci výsledků. Obhajoba práce probíhá před komisí akademických pracovníků. Komise posoudí úroveň práce a rozhodne o hodnocení známkou výborně, velmi dobře, dobře nebo nevyhověl. 1.2 Struktura bakalářské práce Struktura bakalářské práce není předem pevně určena a může se podle typu a zaměření práce lišit. Přesto lze říci, že základní členění prací bývá obdobné. Nyní ho stručně uvedeme. Úvod by měl formulovat obsah, cíle práce a motivaci diplomanta. Je třeba jasně vymezit čím se práce zabývá a jaké cíle a výstupy mají být dosaženy. Odborná část představuje stěžejní část práce. Zde diplomant formuluje východiska práce, postup řešení a dosažené výsledky. Podle zaměření práce bývá také vhodné zpracovat přehledovou část, která stručně popíše aktuální stav řešené problematiky. Pokud je hlavním výsledkem práce softwarová aplikace, pak tato část obsahuje popis řešení aplikace, kde z tohoto popisu musí být jasné, jak je software utvořen, jakými postupy, jaká je jeho vnitřní struktura, jaké byly použité technologie a proč, jaké jsou jeho vlastnosti. Vždy usilujeme o odborný a kritický pohled. Snažíme se vymezit slabé a silné stránky. Při dokumentaci software je žádoucí se zaměřit na podstatné věci, není nutné podat vyčerpávající souhrn nepodstatných informací (k tomuto účelu je možné

9 9 studovat například zdrojový kód) a není vhodné, snad s výjimkou obzvláště důležitých částí, uvádět zdrojové kódy nebo jejich části. Uživatelská část je součástí práce, pokud je výsledkem něco, co je možné uživatelsky používat, nejčastěji softwarová aplikace nebo nějaké zařízení. V takovém případě je potřeba vytvořit uživatelskou příručku, která bude uživatele informovat o tom, jak věc správně používat. Závěr je vhodným místem pro shrnutí práce. Je dobré shrnout dosažené výsledky, uvést zda a jak se výsledky práce uplatňují (nebo by se mohly uplatnit) v praxi a jaký by mohl být další vývoj práce. Text práce musí být psán odborně a kriticky. Autor musí osvědčit svou odbornou úroveň, schopnost kriticky pracovat se zdroji informací, aplikovat vhodné postupy popřípadě přinášet postupy vlastní, originální a odborně přijatelné. Průvodce studiem Práce, která přebírá cizí myšlenky bez uvádění zdrojů je plagiátem. Plagiátorství je velmi hrubým přestupkem proti akademické etice. Autor musí být také dobře obeznámen s aktuálním stavem problematiky. Z práce musí být jasné, jaké zdroje a kdy použil, co je jeho vlastním přínosem a co převzal. Použité zdroje se na příslušných místech v práci citují uvedením zdroje a případně přímou citací dotčené pasáže. Není-li toto hledisko v práci naplněno, bude práce působit neodborným dojmem nebo vznikne podezření, že se jedná o plagiát. Taková práce nemůže být úspěšně obhájena. Použité zdroje se uvádí v seznamu použité literatury. Častou otázkou je požadovaný rozsah práce. Počet stran není důležitým parametrem, text by měl být zejména výstižný. Přiměřený počet stran se může podle tématu dost lišit, lze říci, že bakalářské práce mají běžně cca stran. Není to však žádné pravidlo.

10 10 2 Obhajoba Obhajoba bakalářské práce je součástí Státní závěrečné zkoušky. Probíhá před komisí složenou z akademických pracovníků. Průběh obhajob řídí její předseda, který je zároveň členem komise. Smyslem obhajoby, jak název napovídá, je osvědčit odbornou úroveň diplomanta prostřednictvím bakalářské práce a obhajoby. Před tím, než popíšeme průběh samotné obhajoby, uvedeme co obhajobě předchází. 2.1 Před obhajobou Hotovou bakalářskou práci diplomant s předstihem odevzdá a to způsobem, který určuje příslušný předpis. Tento dokument stanovuje jak má být práce provedena (typografie, vazba, provedení příloh, počet výtisků... ) a kdy, kde a jak má být odevzdána. Poté je pracovištěm stanoven oponent práce. Oponent práce je akademický pracovník (popřípadě jiný dostatečně fundovaný odborník), který se písemně formou posudku kriticky vyjádří ke kvalitě předložené práce. Oponent hodnotí práci zejména z těchto hledisek: jak byly splněny cíle uvedené v zadání jak byly zvoleny postupy při řešení práce dosažené výsledky a jejich přínos jazyková a formální úroveň práce Součástí posudku mohou být také otázky na diplomanta, které by měly být při obhajobě zodpovězeny. Této možnosti oponent využije nejčastěji v situaci, jsou-li některé části práce oponentovi nejasné. Posudek práce končí návrhem oponenta zda doporučuje nebo nedoporučuje práci k obhajobě a návrhem známky (výborně, velmi dobře, dobře, nevyhověl). Průvodce studiem Rozhodně není dobré se spolehnout na odbornou kvalitu práce a ignorovat požadavky na její formální a jazykovou úroveň. V takové situaci bývá nejlepším řešením práci nedoporučit k obhajobě, aby diplomant za jinak vynikající práci neusiloval při obhajobě v lepším případě o známku dobře. Posudek práce vypracovává také vedoucí práce. Hlediska hodnocení jsou obdobná, jako u oponenta, navíc se obvykle vedoucí vyjadřuje také ke spolupráci diplomanta s vedoucím práce (aktivita, samostatnost, schopnost přinášet vlastní a originální řešení... ). Diplomant má právo se s posudky seznámit (obvykle několik dní) před obhajobou. Konkrétní termíny pro posudky stanovuje příslušný přepis. Pokud diplomant obdrží zamítavý posudek (nebo posudky) neznamená to, že nesmí jít k obhajobě. Svou situaci musí posoudit každý diplomant sám, užitečné bývá poradit se s vedoucím práce. 2.2 Průběh obhajoby Jak jsem již uvedli, obhajoba práce probíhá před komisí složenou s akademických pracovníků. Obhajoba je veřejná, takže mohou být přítomny také další osoby. Obvykle

11 11 je přítomen také vedoucí a oponent práce. Samotná obhajoba je vlastně řízenou diskusí nad bakalářskou prací, při které diplomant osvědčuje svou odbornou úroveň. Průběh obhajoby se sestává z posloupnosti následujících kroků: Představení diplomanta - předseda představí diplomanta komisi a stručně uvede bakalářskou práci. Vystoupení diplomanta - diplomant ve vymezeném čase (stanoví předpis, obvykle 15 minut) komisi představí svou práci. Je na diplomantovi, jakým způsobem si připraví své vystoupení. Rozumné je nejprve uvést práci co je předmětem práce a proč, jaká byla motivace diplomanta. Další částí je stručný popis práce z odborného hlediska. Zde diplomant uvádí, jaké použil postupy a proč a k jakým došel k výsledkům. Je-li hlavním výsledkem práce softwarová aplikace, pak by ji diplomant měl během svého vystoupení předvést. Protože čas na vystoupení je dost omezený, je nutné rozvážit co je skutečně podstatné a právě na to se při obhajobě zaměřit. Komise by na základě vystoupení měla získat celkový přehled o obhajované práci jak z hlediska obsahu, tak formy. Průvodce studiem Vystoupení na obhajobě je potřeba si dobře připravit. Je užitečné si rozmyslet alespoň strukturu vystoupení, ještě lepší je však vyzkoušet si obhajobu nanečisto. Vymezený čas je poměrně krátký a není-li obhajoba připravena, pak diplomant stihne pouze část vystoupení. Není výjimkou, že se diplomant vůbec nedostane k podstatě práce. Zkušenosti ukazují, že předsedové komise bývají v tomto ohledu nekompromisní a neumožní diplomantovi vystoupit nad rámec vymezeného času. Seznámení komise s posudkem vedoucího - vedoucí práce seznámí komisi se svým posudkem. V případě nepřítomnosti vedoucího, seznámí přítomné s obsahem posudku některý z členů komise. Seznámení komise s posudkem oponenta - oponent práce seznámí komisi se svým posudkem. V případě nepřítomnosti oponenta, seznámí přítomné s obsahem posudku některý z členů komise. Vyjádření diplomanta k posudkům - diplomant má právo vyjádřit s k jakékoliv části libovolného z posudků. Obsahují-li posudky otázky na diplomanta pak se od diplomanta očekává, že na všechny otázky odpoví. Průvodce studiem Obhajoba bakalářské práce je odborná diskuse. Není to obhajoba před trestním senátem, kde bývá častá snaha, se ze všeho nějak vymluvit. Pokud diplomant prokáže schopnost reflexe vlastní práce, může to být pro něj do jisté míry přínosem před situací, kdy zjevné nedostatky se diplomant snaží vysvětlit. Na druhou stranu to vůbec neznamená, že by diplomant, pokud má jiný názor než členové komise, neměl svůj názor obhajovat. Naopak, měl, je-li o něm přesvědčen a má pro to dostatek argumentů. Diskuze - probíhá zejména mezi členy komise a diplomantem nad bakalářskou prací. Předseda komise může také připustit otázky ostatních přítomných.

12 Hodnocení obhajob probíhá obvykle na závěr, po skončení vystoupení všech diplomantů. Rozhodování komise bývá neveřejné. V případě neúspěchu může diplomant podle platných studijních předpisů obhajobu opakovat. 12

13 13 3 Tvorba odborné části práce V této kapitole uvedeme základní doporučení pro strukturu a obsah odborné části bakalářské práce. Čtenář by měl z odborné části získat stručný avšak ucelený přehled o jejím řešení, a to jak z hlediska použitých postupů, tak technologií, standardů a způsobu implementace software, je-li její součástí. Autor práce musí předpokládat, že čtenář nemusí být s problematikou a použitými technologiemi podrobně seznámen a tento fakt je nutné zohlednit při tvorbě programátorské dokumentace. Odborné pojmy a zkratky, které nemusí být čtenáři obecně známy je třeba v textu náležitě vysvětlit nebo odkázat na příslušnou literaturu. 3.1 Přehledová část Přehledová část obsahuje stručné shrnutí aktuálního stavu řešené problematiky. Dbáme na vymezení řešené oblasti a důsledně pracujeme s literaturou. 3.2 Použité technologie Úvodní část programátorské dokumentace by měla přehledovým způsobem uvést technologie, které byly použity pro řešení problematiky bakalářské práce. Patří sem zejména programovací jazyky, informační technologie, systémové platformy (například Java,.NET) a podobně. Výběr použitých technologií je vhodné stručně zdůvodnit, popřípadě technologie, které připadají v úvahu jako alternativy navzájem porovnat. Tato část je, jak jsme uvedli dříve, přehledová a proto je třeba pamatovat na stručnost, jejím cílem zejména není encyklopedickým způsobem popsat každý technický detail v práci obsažený. 3.3 Rozbor architektury aplikace, struktury kódu a dynamiky aplikace Pro popis toho, jak je aplikace vnitřně organizována a jak je členěn kód je vhodná kombinace textového popisu a diagramů. Pokud je to možné, používáme diagramy, které jsou v odborné veřejnosti zažité a jsou tak pro čtenáře lépe srozumitelné. Nejpoužívanější jsou v současné době diagramy obsažené v jazyce UML. Pro popis aplikace z hlediska funkcí, tak jak je vidí uživatel jsou vhodné diagramy případů užití (use-case diagramy). Pro přehledové zobrazení funkcí a jejich hierarchie jsou vhodné grafické use-case diagramy. Podrobnější popis případů užití můžeme provést pomocí textových scénářů k jednotlivým případům užití. Není nutné psát textové scénáře pro všechny případy užití stačí se zaměřit na ty, které jsou z hlediska aplikace podstatné. Zejména není nutné psát textové scénáře u případů užití, které jsou triviální, nepodstatné nebo se často analogicky opakují. Pokud scénáře z nějakého důvodu nevyhovují, je možné použít jiný, třeba vlastní systém popisu. Strukturu kódu aplikace zachycujeme podle použitého paradigmatu. V případě, že je aplikace implementována objektově, pak je třeba popsat objekty, jejich atributy (v obecném smyslu) a vztahy mezi nimi. Pro tento účel můžeme použít například diagram tříd z jazyka UML, kde zachytíme třídy, jejich vlastnosti a metody, vztahy (včetně kardinality) mezi třídami. Pokud je naše aplikace implementována v některém z méně rozšířených objektových jazyků (například v jazyce založeném na prototypech), mohou být diagramy tříd z jazyka UML nevhodné. UML bylo vytvořeno pro modelování systémů tvořených v populárních, široce používaných jazycích. Dobrou cestou bývá

14 14 nahlédnutí do literatury k daném programovacímu jazyku, jak se takové programy dokumentují. Je dobré textově popsat účel jednotlivých tříd, důležité vlastnosti a metody. To napomůže lepší orientaci v diagramech, resp. interpretaci. Pokud aplikace není implementována pod objektovým paradigmatem, pak aplikaci popíšeme z hlediska použitého paradigmatu - v případě funkcionální paradigmatu z hlediska funkcí a vztahů mezi funkcemi, v případě strukturovaného programování z hlediska procedur, datových struktur a modulů. Pokud je aplikace implementovaná multiparadigmově, pak je vhodné užít kombinaci různých postupů. Programátor v aplikaci implementuje řadu procesů (funkcí), z nichž některé jsou z hlediska celku důležité. Takové procesy je třeba popsat v programátorské dokumentaci, aby byly zachyceny algoritmy, které procesy realizují. Nejčastěji se používá grafické znázornění. Jazyk UML [3] nabízí několik diagramů pro popis dynamiky systému a to podle toho, z jakého hlediska chceme proces popsat. Nejčastěji používaným způsobem je popis z hlediska činnosti algoritmu, který lze zaznamenat diagramem aktivity. Pokud je třeba popsat proces z hlediska stavů objektu a vztahů mezi stavy, pak použijeme stavový diagram. Některé procesy je dobré popsat z hlediska časové následnosti. K tomuto účelu je určen stavový diagram. Jsou-li v návrhu aplikace použity další techniky (například návrhové vzory), je potřebné se o tom v dokumentaci zmínit. V případě návrhových vzorů použité vzory uvedeme a velmi stručně popíšeme. V řadě případů se při implementaci aplikace využívají komponenty třetích stran. Tuto skutečnost v žádném případě nelze v programátorské dokumentaci zamlčet. Naopak, je nutné uvést autora, účel komponenty, způsob jejího užití v aplikaci a důvody pro její volbu. Není nutné ani vhodné, aby v programátorské dokumentaci byl uveden zdrojový kód aplikace. Ten bude uložen na doprovodném CD k bakalářské práci. V situacích, kdy je to z hlediska pochopení nezbytně nutné, můžeme k dílčím problémům uvést části zdrojového kódu. Vždy dbáme na stručnost. 3.4 Datová základna aplikace V úvodu popisu datové základny je vhodné uvést stručný popis použitého řešení, jako je použitý SŘBD, dotazovací jazyk, popř. souborová databáze a podobně. Dále by měl následovat popis datového modelu aplikace. Nejpoužívanějším datovým modelem je model entitně-relační. Pokud jej v datové vrstvě aplikace využíváme, pak v programátorské dokumentaci uvedeme ER-diagram, seznam tabulek s popisem sloupců, jejich datových typů a integritních omezení. Není vhodné namísto ER-diagramu použít grafické znázornění tabulek z aplikace Microsoft Access. Jak známo, datová vrstva může být realizována také jinými, méně často užívanými způsoby: například S-výrazy, XML soubory, objektovou persistencí a podobně. V tomto případě je dobré věnovat pozornost vysvětlení principu fungování takové databázové vrstvy a důvodů pro její volbu. 3.5 Instalátor aplikace K vytvoření instalačního balíčku aplikace můžeme použít některý ze speciálních nástrojů k tomu určených. V programátorské dokumentaci uvedeme jak byla instalace vytvořena.

15 Bezpečnost Specifickou oblastí aplikací je bezpečnost. V programátorské dokumentaci je třeba se vyjádřit zejména k zabezpečení uživatelských práv a přístupu k datům. Tato otázka je obzvláště důležitá u webových aplikací. Při popisu bezpečnosti aplikace se věnujeme možným bezpečnostním hrozbám, jejich řešení a přehledu použitých technologií pro zabezpečení aplikace. 3.7 Standardy V programátorské dokumentaci se autor musí vyjádřit ke standardům. Je vhodné uvést jaké standardy se pro řešení problematiky práce nabízejí, které z nich jsou v aplikací použity a jak je zajištěno jejich naplnění. Tuto otázku je třeba pečlivě zpracovat zejména u webových aplikací. 3.8 Testování aplikace Autor by měl uvést jak byla aplikace testována, jaké je její chování v reálném nasazení a jaká je kompatibilita aplikace s operačními systémy a dalšími technologiemi. U webových aplikací je velmi důležitá kompatibilita s webovými prohlížeči. 3.9 Pár poznámek k sazbě Diagramy, které vkládáme do textu jako obrázky je vhodné vkládat ve vektorových formátech kvůli kvalitě výstupu. V případě, že je obrázek bitmapový (například snímek obrazovky), je třeba aby byl v dostatečném rozlišení tak, aby na tiskovém výstupu nebyl obrázek zkreslený. Také je potřeba dbát na rozumnou míru komprese u ztrátově komprimovaných obrázků, aby nedošlo k citelné degradaci kvality výstupu. Není vhodné používat software, který do výstupu přidává informace o software, ve které byl obrázek vytvořen. Typické je to pro zkušební verze různých aplikací, které do obrázku například přidají vodoznak, nebo jiné označení. Diagramy a jiné tzv. perovky vkládáme v černobílém provedení, u obrázků, které není možné vkládat černobíle jako například snímky obrazovky používáme stupně šedi. U diagramů je nutné dbát na to aby hrany nepocházely přes vrcholy, nebo textové popisky hran neprocházely přes samotné hrany. Můžeme narazit na situaci, že diagram bude příliš velký pro umístění na stránku. Na prvním místě se vždy zamyslíme, zda to co je na obrázku je v pořádku. Není daný problém vyřešen špatně, když je nutné jej zaznamenat tak složitým diagramem? Pokud je nutné, aby byl diagram tak velký, pak bud vysázíme obrázek na výšku, nebo jej rozdělíme na více obrázků. Části, které mají být spojeny, v obrázku označíme. Nezapomeneme to v textu, kde na obrázek odkazujeme, výslovně zmínit. Názvy souborů, proměnných, tříd, vlastností a metod sázíme zásadně strojopisným řezem písma Jazyk práce Bakalářská práce musí mít také náležité jazykové kvality. Dbáme na dodržování odborného stylu. Charakterizují ho tyto vlastnosti: přesnost a jednoznačnost ve vyjadřování

16 16 používání odborných termínů stručnost a věcnost důraz na objektivitu používání autorského plurálu používání neosobního vyjadřování (pasivní konstrukce) Autorský plurál (tzv. plurál skromnosti) znamená, že text formulujeme v první osobě množného čísla. Příklad 3.1. Místo Nyní vysvětlím... použijeme autorský plurál, tedy Nyní vysvětlíme.... Příklad 3.2. Příkladem neosobního vyjadřování je věta V předcházející kapitole bylo uvedeno... Autorský plurál (1. osoba č. mn.)?pokusíme se vysvětlit????ukážeme si na příkladě?? Inkluzivní plurál (1. osoba č. mn.)?věnujme se podrobněji????pokusme se zhodnotit?? Neosobní vyjadřování (pasivní konstrukce)?v předcházející kapitole bylo naznačeno???donedávna se soudilo?? V 1. osobě. č. jednotného?pravdivost tohoto tvrzení dokáži následujícím výpočtem????jsem pevně přesvědčen?? Informatika je typická velkým množstvím cizích slov a používáním anglismů. Není však vhodné anglismy nadužívat je-li k dispozici vhodný český termín, pak jej také použijeme. Příklad 3.3. Například slova jako downloadovat nebo debugovat mají vhodné české protiklady, a to stáhnout a ladit. Vždy je dobré nechat si provést jazykovou korekturu textu. Gramatické chyby jsou špatnou vizitkou diplomanta. Průvodce studiem Zásadně se vyvarujeme používání slangových výrazů jako je například výraz majkrosoftí, hovoříme-li o výrobku firmy Microsoft Práce zaměřená na hardware Specifickým druhem prací jsou práce zaměřené na hardware. U těchto prací je pro porozumění problematice důležité dobře popsat použité technologie a principy funkce navrženého zařízení. Je vhodné uvádět schémata zapojení a především je okomentovat co možná nejsrozumitelnějším způsobem. Uvědomme si, že na školách univerzitního typu se problematice hardware věnuje menší pozornost, než na školách technického typu. Proto i míra porozumění odborného textu s takovým obsahem je na školách univerzitního typu nižší Práce zaměřená na počítačovou hru Jiným specifickým typem bakalářských prací jsou počítačové hry. Zde je podstatné neopomenout popis kompletní mapy anebo scénáře hry včetně postupu jak lze hru dohrát. Dále je třeba se zaměřit na stránku grafických technologií použitých ve hře a technologií použitých pro realizaci strategie hry počítačem (algoritmy a heuristiky).

17 17 4 Tvorba uživatelské dokumentace Účelem uživatelské dokumentace je poskytnout uživateli návod na ovládání aplikace. Autor aplikace musí, podobně jako při tvorbě uživatelského rozhraní zohlednit, jaká skupina uživatelů bude s jeho aplikací pracovat a podle toho také tvořit uživatelskou dokumentaci. Obecně je vhodné, aby uživatelské dokumentaci porozuměl uživatel počítače se základními znalostmi o jeho ovládání. Pokud je aplikace určena pro užší skupinu uživatelů (zkušené uživatele, specialisty na určitou oblast, jako například grafiku, zvuk a podobně), nemusíme volit tak detailní popis ovládání, nebo zpracovávané problematiky jako u aplikací určených pro široké vrstvy uživatelů. Na druhou stranu je třeba dbát, aby se autor ve snaze vše uživateli vysvětlit nekryl s manuálem ke uživatelského rozhraní systému, například není nutné vysvětlovat co je kliknutí myší, že se velká písmena píší pomocí klávesy Shift a podobně. Při tvorbě dokumentace k ovládání aplikace je vhodné používat snímky oken, popřípadě pokud se chceme zaměřit na detail (část okna), pak je lepší použít výřez okna. Uvědomme si, že uživatelé nečtou příliš rádi čtou manuály a je dobré, když je možné se samotných snímků obrazovky se v dané úloze zorientovat. Výřez okna je přehlednější a v textu nezabere tolik místa. Je důležité, aby bylo zjevné, že se jedná o výřez okna, aby uživatel nebyl zmaten tím, že nemůže takové okno v aplikaci najít. Kromě obrázků používáme textový popis, ve kterém se na jednotlivé obrázky odkazujeme. Názvy ovládacích prvků je vhodné v textu uvádět, protože se zlepšuje orientaci v dialozích. Styl textu by měl být stejný jako v ostatních kapitolách práce, není vhodné se inspirovat žoviálním jazykem některých manuálů aplikací dostupných na trhu. Kromě názvu ovládacího prvku uvádíme také jeho titulek, resp. popisku je-li k ovládacímu prvku přiřazena. Název popisky sázíme bud v uvozovkách, nebo kurzívou. Příklad 4.1. Dobré: Klikneme na Časové pásmo. Lepší: Klikneme na rozbalovací seznam Časové pásmo Klikneme na tlačítko OK. Do textového pole Adresa uvedeme Struktura uživatelské dokumentace V úvodu programátorské dokumentace nejprve popíšeme instalaci aplikace. Měli bychom zmínit jaké volby při instalaci lze nastavit a co znamenají. Dále uvedeme jakým způsobem se aplikace spustí (kde se nachází její zástupce a podobně) a pokud je do aplikace třeba přihlášení, jak se lze přihlásit. Zde je vhodné uvést jména a hesla pro uživatele všech rolí v aplikaci, aby je uživatel (což může být také vedoucí práce, nebo její oponent) mohl vyzkoušet. Pak následuje hlavní část uživatelské dokumentace, která popisuje zpracování jednotlivých úloh (funkcí) v aplikaci. Popis by měl být organizován analogicky s organizací dialogů v aplikaci, tedy od hlavního okna k oknům podřízeným. Pokud je aplikace rozsáhlá, může být užitečné uvést strom dialogů. Jednotlivé úlohy je vhodné popisovat stylem krok za krokem. Popis zpracování uživatelských úloh je vhodné rozdělit z hlediska rolí. Například na popis úloh pro běžného uživatele a správce aplikace. Poté co je popsáno ovládání aplikace, věnujeme se možnostem nastavení parametrů pro aplikaci. Na závěr uživatelské dokumentace uvedeme, jak je možné aplikaci odinstalovat.

18 Pracovní scénáře Problematika některých témat nemusí být obecně známa a tak samotná uživatelská příručka nemusí být dostatečná pro pochopení, jakým způsobem software správně používat. V takovém případě je vhodné, aby v úvodu práce diplomant problematiku stručně vysvětlil a v uživatelské příručce uvedl několik scénářů, které krok po kroku umožní vyzkoušet stěžejní funkce aplikace. Příklad 4.2. Uvažme jako příklad aplikaci pro tzv. vyvolávací systém. To je systém, se kterým se setkáváme na úřadech, kdy si klient vyžádá z počítače podle služby pořadový lístek s číslem, podle kterého je potom volán na příslušné pracoviště, kde splní jeho požadavek. Přestože každý s takovým systémem v praxi přišel do styku, nebude uživateli aplikace, která se o správu klientských požadavků stará, předem jasné, jak vlastně tuto aplikaci používat. Proto je dobré uvést stylem krok po kroku příklad pro vyzkoušení hlavních funkcí takové aplikace. Například vydání lístku, správa fronty, obsloužení klienta a podobně.

19 19 5 Sazba textu práce v typografickém systému TEX s balíkem maker L A TEX V této kapitole se čtenář seznámí se základy tvorby dokumentů v systému L A TEX a se zásadami sazby bakalářské práce. Tato kapitola je tedy užitečná i pro ty, kteří budou práci případně sázet v jiné aplikaci. TEX (čteme tech) je typografický formátovací software určený pro sazbu dokumentů. Autorem tohoto systému je Donald E. Knuth. TEX byl původně vytvořen pro sazbu technických a matematicky zaměřených textů, ale je možné jej používat i pro sazbu ostatních dokumentů. TEX pracuje jako řádkový překladač, který vstupní soubor, nebo soubory, které obsahují formátovací příkazy přeloží (vysází) do výstupního souboru ve formátu DVI. Soubor ve formátu DVI, je možné snadno převádět například do formátu PostScript pomocí programu dvips, nebo do formátu PDF programem dfipdfm. Existuje také varianta TEXu zvaná pdftex, která produkuje výstup přímo ve formátu PDF a podporuje specifické možnosti tohoto formátu, jako je sazba hypertextových odkazů, nebo obsahu v PDF souboru. TEX je volně dostupný software a obvykle se vydává v tzv. distribucích (podobně jako operační systém Linux). Existuje řada distribucí pro nejrůznější platformy a některé distribuce jsou dokonce víceplatformní. Asi nejpoužívanější distribucí pro operační systémy z rodiny Windows je TEXLive, která je dostupná na Pro operační systém Linux se nejčastěji setkáme s verzí TEXu nazvanou TeTEX ( která se dodává obvykle jako balíček dané distribuce Linuxu a je tedy možné jej jednoduchým a systémovým způsobem nainstalovat. Pro operační sytém MacOS X jsou nejpoužívanějšími distribucemi MacTEX ( a TeTEX. Při instalaci, zejména pod MS Windows, je vhodné prostudovat dokumentaci, kde bývá kromě jiného uvedeno, jak zvolit parametry instalace tak, aby se nainstalovalo také české prostředí pro TEX a L A TEX. Protože zdrojově soubory TEXu jsou vlastně obyčejné textové soubory, můžeme je vytvářet v libovolném textovém editoru, který je schopen ukládat textové soubory. Takový soubor následně přeložíme TeXem a získáme výsledný vysázený dokument. Pro TEX existují také specializované editory, které vytváření souborů usnadňují. Tyto editory bývají součástí některých distribuci. Pro systémy z rodiny Windows jsou nejpoužívanějšími editory LeD ( Wind- Shell ( a TEXnicCenter ( V systému Linux se často používá textový editor Emacs, který obsahuje zvláštní editační mód pro TeX. V systému MacOS X jsou nejpoužívanější editory TEXShop ( koch/texshop/) a itexmac ( Po instalaci editoru je třeba provést nastavení parametrů pro překlad souborů TEXem, tak aby správně pracovalo české prostředí. L A TEX (čteme latech, popřípadě lejtech) je balík maker pro TEX, která usnadňují sazbu běžných dokumentů. L A TEX existuje ve více verzích, v současné době je však nejpoužívanější verze L A TEX 2e, na kterou se v tomto textu zaměříme. Následující popis balíku maker L A TEX je pouze přehledem těch nejzákladnějších příkazů L A TEXu a je určen úplným začátečníkům. Pro podrobnější popis odkazujeme na [4]. 5.1 Základy Znaky mezera, tabulátor a konec řádku jsou interpretovány jako jedna mezera. Prázdný řádek, nebo i více prázdných řádků se interpretuje jako konec odstavce. mezery, znaky

20 20 Mezi slovy bude jedna mezera. Mezi slovy bude jedna mezera. Zde je nový odstavec. Zde je nový odstavec. A ještě jeden odstavec. A ještě jeden odstavec. Znaky $ & % # _ { } ˆ \ mají v L A TEXu speciální význam a tak je nelze sázet prostým zapsáním do textu. Pokud chceme takový znak vysázet, musíme před tímto znakem uvést obrácené lomítko. $ & % # { } \$ \& \% \# \_ \{ \} Příkazy v L A TEXu začínají znakem zpětné lomítko. Poté následuje název příkazu. V názvech příkazů se rozlišují malá a velká písmena. Některé příkazy vyžadují ještě parametr, který se uvádí v množinových závorkách. Poslední slovo bude vysázeno tučně. Poslední slovo bude vysázeno \textbf{tučně}. Ve vstupním souboru se mohou také vyskytovat komentáře. Vše co se vyskytuje za znakem % bude až do konce řádku ignorováno. Moudrý text. Moudrý %i hloupý text. 5.2 Struktura souboru Vstupní soubor musí mít na začátku deklarovaný styl dokumentu příkazem documentclass. Styl dokumentu definuje, jak se mají jeho jednotlivé části sázet, takže kromě jiného definuje například rozměry stránky, velikosti písem, nebo řezy písem. Nejpoužívanějšími styly jsou article, dále například report, nebo book. Po deklaraci stylu dokumentu může následovat příkaz usepackage, kterým deklarujeme použití dodatečného balíčku maker. Běžně můžeme potřebovat v dokumentu používat více balíčků. Pro nás důležitým balíčkem bude balíček czech, který zavede české prostředí a dále balíček graphicx, který budeme používat pro práci s obrázky. Dále může následovat samotný dokument, kde začátek samotného dokumentu je uvozen příkazem \begin{document} a konec příkazem \end{document}. Typická hlavička našich dokumentů může vypadat například takto: \documentclass[11pt]{article} \usepackage{czech} \usepackage{graphicx} \begin{document} \end{document} V případě, že sázíme rozsáhlejší text je výhodné si text organizovat ve více souborech (například po kapitolách) pro lepší přehlednost a orientaci ve zdrojových souborech. Vložení souboru se provádí příkazem \input{soubor}, kde parametr soubor představuje název souboru, který má být vložen na místo příkazu ve zdrojovém souboru.