Osnova dokumentace maturitní práce

Z MiS
(Rozdíly mezi verzemi)
Přejít na: navigace, hledání
m (Přejmenování projekt-> maturitní práce)
m (Oprava odkazu na Moodle)
 
(Není zobrazeno 7 mezilehlých verzí od 1 uživatele.)
Řádka 1: Řádka 1:
<div class="Souvisejici">Související stránky: [[Harmonogram maturitní práce]]</div>
+
[[Category:Maturitní práce]][[Category:VSE]][[Category:OA]][[Category:Dokumentace projektu]]
[[Category:Maturitní práce]][[Category:VSE]][[Category:OA]]
+
  
Šablonu dokumentu včetně návodu naleznete na stránkách školy po přihlášení do [https://www.oauh.cz/index.php?id=434 Intranetu OA].
+
Šablonu dokumentu včetně návodu naleznete [https://moodle.oauh.cz/course/view.php?id=97 na školním Moodle po přihlášení školním účtem].
  
== Dokumentace maturitní práce obecně ==
+
 
 +
== Struktura práce ==
 +
Odborné práce mají záměrně velmi pevnou strukturu. Cílem je, aby čtenář nemusel číst celou práci, ale rychle našel vše, co potřebuje.
 +
 
 +
; Součásti odborné práce
 +
# Úvodní stránka
 +
# Prohlášení, zadání, další povinné informace...
 +
# Anotace/resumé
 +
#* Celý projekt shrnutý do dvou odstavců &nbsp; co se dělá a jaké technologie použijeme
 +
#* Když si ji přečtu, měl bych vědět, jestli chci číst dál
 +
#* '''Ne'''pište: že je to projekt na OA, že vás to bavilo,...
 +
# Obsah (seznam kapitol — ideálně s&nbsp;hypertextovými odkazy)
 +
# Úvod
 +
#* Motivace a cíl práce
 +
#* Od začátku, je třeba představit důležité pojmy
 +
#* Část informací už zazněla v&nbsp;anotaci, ale úvod musí být samostatně čitelný i&nbsp;pro toho, kdo anotaci nečetl.
 +
# Teoretický úvod
 +
#* Stručné představení pozadí projektu.
 +
#* Na IT typicky netriviální technologie, které jste použili a ostatní by nemuseli znát.
 +
#* O každé technologii cca 1-2 odstavce '''souvislého textu''' &mdash; ne jen body.
 +
# Popis práce
 +
#* ...
 +
#* Tady se struktura kapitol může lišit podle povahy práce
 +
#* Sem patří i&nbsp;kapitola s&nbsp;návodem na instalaci a&nbsp;zprovoznění projektu
 +
# Závěr
 +
#* '''Znovu''' stručně &mdash; co se povedlo udělat, co se nepovedlo.
 +
# Použité zdroje
 +
#* Formátujte podle normy (použijte [https://www.citace.com Citace.com])
 +
#* Jaké zdroje uvádět:
 +
#** Pěkné podrobné tutoriály, učebnice, které si uživatel může přečíst o daném tématu a&nbsp;které vám pomohly.
 +
#** Konkrétní zdroje, které citujete v&nbsp;práci.
 +
#** Konkrétní zdroje, ze kterých jste brali kód či myšlenky.
 +
#** Min. 5 zdrojů (relevantních).
 +
 
 +
 
 +
== Jak si rozvrhnout čas ==
 
Nejdůležitější (a nejsložitější) je napsat úvod a závěr. Tyto dvě kapitoly by měly stačit k tomu, aby čtenář pochopil:
 
Nejdůležitější (a nejsložitější) je napsat úvod a závěr. Tyto dvě kapitoly by měly stačit k tomu, aby čtenář pochopil:
 
# co jste chtěli řešit (úvod)
 
# co jste chtěli řešit (úvod)
Řádka 18: Řádka 52:
 
Tedy úplně nejdůležitější je úvod. Protože závěr už vlastně vychází z úvodu a komentuje, co se povedlo a co ne. Stejně jako ostatní kapitoly, které rozvíjí témata, nastíněná v úvodu práce.
 
Tedy úplně nejdůležitější je úvod. Protože závěr už vlastně vychází z úvodu a komentuje, co se povedlo a co ne. Stejně jako ostatní kapitoly, které rozvíjí témata, nastíněná v úvodu práce.
  
Navíc v úvodu musíte začít... Zkrátka, úvod budete třikrát přepisovat, brrr! Ale vyplatí se to! ;)
+
Navíc v úvodu musíte začít... Zkrátka, úvod budete opakovaně přepisovat a doplňovat, brrr! Ale vyplatí se to! ;)
 
</div>
 
</div>
  
Řádka 28: Řádka 62:
  
  
== Úvod práce podrobněji ==
+
 
 +
== Úvod práce ==
  
 
Popište na cca jedné straně formátu A4, co jste řešili a k jakým výsledkům jste dospěli. Při psaní vycházíte z [[Úvodní analýza maturitní práce|úvodní analýzy]].
 
Popište na cca jedné straně formátu A4, co jste řešili a k jakým výsledkům jste dospěli. Při psaní vycházíte z [[Úvodní analýza maturitní práce|úvodní analýzy]].
Řádka 38: Řádka 73:
 
* ...
 
* ...
  
; Jaké byly požadavky na výsledný produkt?
+
; Cílová skupina uživatelů
 +
* Pro jakou cílovou skupinu je produkt určený.
 +
 
 +
; Jaké jsou požadavky na výsledný produkt?
 
* Klademe nějaká omezení na produkt? Co musí splňovat? Proč? (Buďte konkrétní!!!)
 
* Klademe nějaká omezení na produkt? Co musí splňovat? Proč? (Buďte konkrétní!!!)
 
* Jaké prostředky jsme použili?
 
* Jaké prostředky jsme použili?
Řádka 61: Řádka 99:
 
* Ke každé z dalších kapitol (kromě závěru) shrňte jednou větou, o čem kapitola je.
 
* Ke každé z dalších kapitol (kromě závěru) shrňte jednou větou, o čem kapitola je.
  
== Stručná osnova dalších kapitol práce ==
+
 
 +
== Teoretický úvod do problematiky ==
 +
 
 +
=== Seznámení čtenáře s&nbsp;problematikou ===
 +
 
 +
Pokud se zabýváte tématem, které není běžně známé, připravte pro čtenáře stručný souhrn, který potřebuje pro pochopení vaší práce.
 +
 
 +
Zde budete často pracovat se zdroji, které si přečtete a na základě nichž text zpracujete.
 +
 
 +
Pokud je vaším úkolem vytvořit aplikaci (mobilní, webovou,...), tuto část nejspíš můžete vynechat.
  
 
=== Použité technologie ===
 
=== Použité technologie ===
 +
 
Popište technologie, které jste použili. Vysvětlete jejich význam v rámci vašeho projektu. Očekávejte, že Váš čtenář má základní přehled v oblasti IT, ale nezná konkrétní náležitosti Vašeho produktu.
 
Popište technologie, které jste použili. Vysvětlete jejich význam v rámci vašeho projektu. Očekávejte, že Váš čtenář má základní přehled v oblasti IT, ale nezná konkrétní náležitosti Vašeho produktu.
  
Řádka 70: Řádka 118:
 
</div>
 
</div>
  
=== Popis řešení ===
+
=== Průzkum konkurenčních řešení ===
Popište důležité součásti vašeho řešení. Opět očekávejte od svého čtenáře základní přehled v oblasti IT.  
+
Prozkoumejte, jaká alternativní řešení se nabízí na trhu. Vyzkoušejte je, projděte jejich vlastnosti a&nbsp;sepište stručný souhrn. Shrňte, v&nbsp;čem má být vaše aplikace/váš produkt jiná(ý)/lepší.
 +
 
 +
Tuto část obvykle řešíte ještě před začátkem řešení.
 +
 
 +
 
 +
== Popis řešení ==
 +
Popište důležité součásti vašeho řešení.
 +
 
 +
Konkrétní obsah se liší podle povahy projektu. Pokud například srovnáváte dva e-learningové systémy, bude obsah této kapitoly zcela jiný než u&nbsp;projektu, kde se vytváří aplikace.
 +
 
 +
Ale pokud programujete aplikaci, velmi často budete psát následující části:
 +
 
 +
=== Model dat aplikace ===
 +
Popište, s&nbsp;jakými daty pracuje vaše aplikace. Využijte ER model či diagram tříd podle toho, jestli je vaše aplikace založena na SQL databázi, či spíše objektově orientovaná (můžete samozřejmě použít oboje, pokud vaše aplikace používá obojí).
 +
 
 +
=== Návrh uživatelského rozhraní a&nbsp;jeho testování ===
 +
Na začátku práce si potřebujete rozmyslet, jak bude vypadat uživatelské rozhraní vaší aplikace. Zde je dobré místo shrnout návrh a&nbsp;zdůvodnit volby.
 +
 
 +
Popíšete také, jakým způsobem jste návrh aplikace testovali.
 +
 
 +
=== Popis implementace ===
 +
Popište, jakým způsobem vaše aplikace zpracovává data.
 +
 
 +
Pokud jste museli najít či vymyslet nějaký náročnější algoritmus, popište zde jeho fungování.
 +
 
 +
Opět očekávejte od svého čtenáře základní přehled v oblasti IT zhruba na úrovni úspěšného absolventa naší školy.  
  
 
<div class="Priklad">
 
<div class="Priklad">
Řádka 77: Řádka 150:
 
</div>
 
</div>
  
 +
 +
=== Popis testování produktu ===
 +
Popište, jakým způsobem jste testovali svůj produkt. Uveďte kterým lidem jste produkt nechávali testovat, jaké podněty jste z&nbsp;testování získali a&nbsp;jak jste je promítli do výsledného produktu.
 +
 +
=== Zdůvodnění případných změn ===
 
Pokud jste museli upravit původní znění zadání, zde je dobré místo pro podrobnější zdůvodnění změn.
 
Pokud jste museli upravit původní znění zadání, zde je dobré místo pro podrobnější zdůvodnění změn.
  
Řádka 82: Řádka 160:
 
K čemu jsme dospěli, co výsledný program umí. Co se naopak nepovedlo a jak jsme to napravili.
 
K čemu jsme dospěli, co výsledný program umí. Co se naopak nepovedlo a jak jsme to napravili.
  
U některých projektů je tuto kapitolu možné a vhodné spojit se závěrem, zvláště pokud je výsledkem projektu program a výsledkem práce je tedy kód programu. Naopak u teoreticky zaměřených prací je tato kapitola obvykle obsáhlejší.
+
U některých projektů je tuto kapitolu možné a vhodné spojit se závěrem, zvláště pokud je výsledkem projektu program a výsledkem práce je tedy kód programu. Naopak u teoreticky zaměřených prací je tato kapitola obvykle obsáhlejší a&nbsp;v&nbsp;závěru zmíníte pouze nejzásadnější výsledky.
  
 
=== Porovnání s alternativními produkty ===
 
=== Porovnání s alternativními produkty ===
Řádka 88: Řádka 166:
 
Samozřejmě pouze pokud je výsledkem projektu nějaký produkt. ;)
 
Samozřejmě pouze pokud je výsledkem projektu nějaký produkt. ;)
  
=== Závěr ===
+
 
 +
== Závěr ==
 
* Shrňte vlastnosti výsledného produktu.
 
* Shrňte vlastnosti výsledného produktu.
 
* Podařilo se nám splnit cíle projektu? Které ano a které ne? Zdůvodněte.
 
* Podařilo se nám splnit cíle projektu? Které ano a které ne? Zdůvodněte.
Řádka 96: Řádka 175:
  
 
== Použité zdroje ==
 
== Použité zdroje ==
=== Citování zdrojů ===
+
* Uvádíte zdroje, které:
* Použité zdroje uveďte na konci práce v Seznamu použitých zdrojů.
+
** doslovně citujete v práci.
* K citování zdrojů použijte pravidla dle normy ČSN ISO 690.  
+
** Z nichž čerpáte informace.
* (Při citování webových stránek NEuvádějte pouze URL adresy stránek!)
+
** Které považujete za zajímavé a doporučujete čtenáři jejich studium.
* Snažte se používat zdroje s konkrétním autorem, spíše se vyhýbejte Wikipedii a podobným médiím, které se mohou měnit bez upozornění.
+
* Není třeba rozlišovat, do které z kategorií zdroj patří.
 +
* Neměli byste citovat zdroje, které jste vůbec nečetli. Někdy se rozlišují kapitoly: ''Použitá literatura'' a ''Doporučená literatura''.
  
<div class="Poznamka">Pro tvorbu citací doporučuji stránky [http://www.citace.com Citace.com].</div>
+
Viz také: [[Citování zdrojů]]
 
+
=== Přebírání informací ===
+
Pokud přebíráte informace z cizích zdrojů (takové informace, které jste sami neobjevili), pak:
+
; Pokud citujete zdroj doslova:
+
* Uveďte výslovně:
+
*: ''K. Malina v monografii [1] uvádí: „Jahody jsou obvykle červené.“''
+
* ''[1]'' je zde odkaz na citaci zdroje v seznamu použité literatury.
+
* Tento způsob citování je vhodný pro matematické věty, významná tvrzení apod., kdy by přetlumočení vlastními slovy bylo zavádějící nebo nepřesné.
+
* '''Tímto způsobem nikdy necitujte celé kapitoly textu, je to porušení autorské etiky!'''
+
; Berete-li informace ze zdroje, ale píšete vlastní text, osnova textu ani text samotný '''nekopíruje významně''' zdroj:
+
* Berete-li konkrétní poznatky, u každého poznatku uveďte číslem odkaz do seznamu použité literatury.
+
*: ''Jahody jsou obvykle červené (viz [1], strana 15).''
+
* Pokud nepříklad v teoretickém úvodu vycházíte v průběhu celého odstavce z nějaké knihy či jiného zdroje, napište knihu pouze do seznamu použité literatury, konkrétní odkazy průběžně psát nemusíte, předpokládáme, že by jich bylo hodně a bylo by to tedy nepraktické. Za danou částí doporučujeme uvést odkaz na citovanou literaturu:
+
*: ''Podrobněji viz [1].''
+
; Doporučujete zdroj k dalšímu studiu (i když ho přímo nepoužíváte):
+
* Do seznamu použité literatury lze také uvést zdroje, které sice přímo nepoužíváte, ale které doporučujete k prostudování, protože doplňují text vaší práce o další fakta.
+
* Ideálně v takovém případě uveďte například v teoretickém úvodu toto doporučení s odkazem na konkrétní zdroj.
+
* Tento způsob citování je vyjímečný, měl by se týkat jen omezeného množství velmi užitečných zdrojů, které by jinak čtenář asi nenašel (určitě tímto způsobem necitujte Wikipedii a spol.).
+
 
+
<div class="Varovani">
+
Neměli byste citovat zdroje, které jste nečetli!!!!
+
</div>
+
  
 
== Přílohy ==
 
== Přílohy ==
Řádka 135: Řádka 193:
 
* skript pro vytvoření databáze, pokud je potřeba
 
* skript pro vytvoření databáze, pokud je potřeba
 
* hesla a přihlašovací jména účtů pro vyzkoušení aplikace
 
* hesla a přihlašovací jména účtů pro vyzkoušení aplikace
 +
 +
== Související stránky ==
 +
*[[Harmonogram maturitní práce]]

Aktuální verze z 7. 10. 2022, 06:14


Šablonu dokumentu včetně návodu naleznete na školním Moodle po přihlášení školním účtem.


Obsah

Struktura práce

Odborné práce mají záměrně velmi pevnou strukturu. Cílem je, aby čtenář nemusel číst celou práci, ale rychle našel vše, co potřebuje.

Součásti odborné práce
  1. Úvodní stránka
  2. Prohlášení, zadání, další povinné informace...
  3. Anotace/resumé
    • Celý projekt shrnutý do dvou odstavců   co se dělá a jaké technologie použijeme
    • Když si ji přečtu, měl bych vědět, jestli chci číst dál
    • Nepište: že je to projekt na OA, že vás to bavilo,...
  4. Obsah (seznam kapitol — ideálně s hypertextovými odkazy)
  5. Úvod
    • Motivace a cíl práce
    • Od začátku, je třeba představit důležité pojmy
    • Část informací už zazněla v anotaci, ale úvod musí být samostatně čitelný i pro toho, kdo anotaci nečetl.
  6. Teoretický úvod
    • Stručné představení pozadí projektu.
    • Na IT typicky netriviální technologie, které jste použili a ostatní by nemuseli znát.
    • O každé technologii cca 1-2 odstavce souvislého textu — ne jen body.
  7. Popis práce
    • ...
    • Tady se struktura kapitol může lišit podle povahy práce
    • Sem patří i kapitola s návodem na instalaci a zprovoznění projektu
  8. Závěr
    • Znovu stručně — co se povedlo udělat, co se nepovedlo.
  9. Použité zdroje
    • Formátujte podle normy (použijte Citace.com)
    • Jaké zdroje uvádět:
      • Pěkné podrobné tutoriály, učebnice, které si uživatel může přečíst o daném tématu a které vám pomohly.
      • Konkrétní zdroje, které citujete v práci.
      • Konkrétní zdroje, ze kterých jste brali kód či myšlenky.
      • Min. 5 zdrojů (relevantních).


Jak si rozvrhnout čas

Nejdůležitější (a nejsložitější) je napsat úvod a závěr. Tyto dvě kapitoly by měly stačit k tomu, aby čtenář pochopil:

  1. co jste chtěli řešit (úvod)
  2. proč jste to chtěli řešit (úvod)
  3. jaké technologie jste chtěli použít (úvod)
  4. jaké úkoly je třeba splnit (úvod)
  5. jak se pozná, jestli jste zadání splnili: „co produkt musí splňovat“ (úvod)
  6. co se vám povedlo (závěr)
  7. jaké změny v zadání jste museli provést a proč (závěr)
  8. v čem by se mělo (dalo) pokračovat dál v případných navazujících projektech (závěr)

Tedy úplně nejdůležitější je úvod. Protože závěr už vlastně vychází z úvodu a komentuje, co se povedlo a co ne. Stejně jako ostatní kapitoly, které rozvíjí témata, nastíněná v úvodu práce.

Navíc v úvodu musíte začít... Zkrátka, úvod budete opakovaně přepisovat a doplňovat, brrr! Ale vyplatí se to! ;)

Dále je stručně popsán obsah jednotlivých kapitol Vaší práce.

Pro konkrétní projekty lze samozřejmě osnovu upravit, k úpravám by však měl být dobrý důvod a doporučujeme změny konzultovat s vedoucím práce.


Úvod práce

Popište na cca jedné straně formátu A4, co jste řešili a k jakým výsledkům jste dospěli. Při psaní vycházíte z úvodní analýzy.

Co bylo cílem práce?
Cílová skupina uživatelů
Jaké jsou požadavky na výsledný produkt?
Popis výsledku
Praktické nasazení
Porovnání s existujícími produkty
Stručně obsah dalších kapitol


Teoretický úvod do problematiky

Seznámení čtenáře s problematikou

Pokud se zabýváte tématem, které není běžně známé, připravte pro čtenáře stručný souhrn, který potřebuje pro pochopení vaší práce.

Zde budete často pracovat se zdroji, které si přečtete a na základě nichž text zpracujete.

Pokud je vaším úkolem vytvořit aplikaci (mobilní, webovou,...), tuto část nejspíš můžete vynechat.

Použité technologie

Popište technologie, které jste použili. Vysvětlete jejich význam v rámci vašeho projektu. Očekávejte, že Váš čtenář má základní přehled v oblasti IT, ale nezná konkrétní náležitosti Vašeho produktu.

Například pro projekt programovaný pomocí knihovny GD v PHP stačí jen velmi letmo zmínit, co je to jazyk PHP, měli byste se ale podrobněji zabývat funkcemi knihovny GD, které jste ve svém projektu použili.

Průzkum konkurenčních řešení

Prozkoumejte, jaká alternativní řešení se nabízí na trhu. Vyzkoušejte je, projděte jejich vlastnosti a sepište stručný souhrn. Shrňte, v čem má být vaše aplikace/váš produkt jiná(ý)/lepší.

Tuto část obvykle řešíte ještě před začátkem řešení.


Popis řešení

Popište důležité součásti vašeho řešení.

Konkrétní obsah se liší podle povahy projektu. Pokud například srovnáváte dva e-learningové systémy, bude obsah této kapitoly zcela jiný než u projektu, kde se vytváří aplikace.

Ale pokud programujete aplikaci, velmi často budete psát následující části:

Model dat aplikace

Popište, s jakými daty pracuje vaše aplikace. Využijte ER model či diagram tříd podle toho, jestli je vaše aplikace založena na SQL databázi, či spíše objektově orientovaná (můžete samozřejmě použít oboje, pokud vaše aplikace používá obojí).

Návrh uživatelského rozhraní a jeho testování

Na začátku práce si potřebujete rozmyslet, jak bude vypadat uživatelské rozhraní vaší aplikace. Zde je dobré místo shrnout návrh a zdůvodnit volby.

Popíšete také, jakým způsobem jste návrh aplikace testovali.

Popis implementace

Popište, jakým způsobem vaše aplikace zpracovává data.

Pokud jste museli najít či vymyslet nějaký náročnější algoritmus, popište zde jeho fungování.

Opět očekávejte od svého čtenáře základní přehled v oblasti IT zhruba na úrovni úspěšného absolventa naší školy.

Není tedy například třeba popisovat, jak funguje ve Vašem kódu podmínka if či cyklus for v PHP, vysvětlete spíše, proč je tuto podmínku potřeba pohlídat a k čemu používáte proměnné v podmínce, pokud jejich význam není být z názvu zcela zřejmý.


Popis testování produktu

Popište, jakým způsobem jste testovali svůj produkt. Uveďte kterým lidem jste produkt nechávali testovat, jaké podněty jste z testování získali a jak jste je promítli do výsledného produktu.

Zdůvodnění případných změn

Pokud jste museli upravit původní znění zadání, zde je dobré místo pro podrobnější zdůvodnění změn.

Výsledky

K čemu jsme dospěli, co výsledný program umí. Co se naopak nepovedlo a jak jsme to napravili.

U některých projektů je tuto kapitolu možné a vhodné spojit se závěrem, zvláště pokud je výsledkem projektu program a výsledkem práce je tedy kód programu. Naopak u teoreticky zaměřených prací je tato kapitola obvykle obsáhlejší a v závěru zmíníte pouze nejzásadnější výsledky.

Porovnání s alternativními produkty

V úvodu jsme nastínili vizi, jak to mělo být. Tady už pracujeme s tvrdou realitou. Jak je na tom náš produkt ve skutečnosti... ;) Samozřejmě pouze pokud je výsledkem projektu nějaký produkt. ;)


Závěr

Použité zdroje

Viz také: Citování zdrojů

Přílohy

Obsah CD

Související stránky

Osobní nástroje
Jmenné prostory
Varianty
Akce
Výuka
Navigace
Nástroje