Osnova dokumentace maturitní práce
m (Přidána kategorie Maturitní projekt) |
(Upraven úvod) |
||
| Řádka 30: | Řádka 30: | ||
== Úvod práce podrobněji == | == Úvod práce podrobněji == | ||
| − | Popište na cca jedné straně formátu A4 | + | 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 projektu|úvodní analýzy projektu]]. |
| − | ; Co | + | |
| + | ; Co bylo cílem projektu? | ||
* fungující program? | * fungující program? | ||
* porovnání metod? | * porovnání metod? | ||
| Řádka 37: | Řádka 38: | ||
* ... | * ... | ||
| − | ; Jaké | + | ; Jaké byly 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 | + | * Jaké prostředky jsme použili? |
; Popis výsledku | ; Popis výsledku | ||
* Jaké jsou základní součásti produktu? | * Jaké jsou základní součásti produktu? | ||
| − | * | + | * K jakým výsledkům jste dospěli? |
| − | * | + | * Do jaké fáze původně plánovaného rozsahu se podařilo dojít? |
| − | * | + | ** Splnili jste základní prototyp? |
| − | * | + | ** Zvládli jste vyřešit některá rozšíření? Která? |
| − | * | + | * Narazili jste na neočekávané problémy? Jaká řešení jste nalezli? |
| − | ; | + | ; Praktické nasazení |
| − | * | + | * Je výsledný produkt někde používán v praxi? |
| + | * Je takové použití domluveno, plánováno? | ||
; Porovnání s existujícími produkty: | ; Porovnání s existujícími produkty: | ||
* Existují nějaké podobné produkty? | * Existují nějaké podobné produkty? | ||
| − | * V čem | + | * V čem je projekt jiný než podobné existující produkty? |
| − | ; | + | ; Stručně obsah dalších kapitol |
| + | * 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 == | == Stručná osnova dalších kapitol práce == | ||
Verze z 18. 3. 2012, 22:47
Šablonu dokumentu včetně návodu naleznete na stránkách školy po přihlášení do Intranetu OA.
Obsah |
Dokumentace projektu obecně
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)
- proč jste to chtěli řešit (úvod)
- jaké technologie jste chtěli použít (úvod)
- jaké úkoly je třeba splnit (úvod)
- jak se pozná, jestli jste zadání splnili: „co produkt musí splňovat“ (úvod)
- co se vám povedlo (závěr)
- jaké změny v zadání jste museli provést a proč (závěr)
- 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 třikrát přepisovat, 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 podrobněji
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 projektu.
- Co bylo cílem projektu?
- fungující program?
- porovnání metod?
- vyzkoušení postupu, technologie, nástroje,...?
- ...
- Jaké byly požadavky na výsledný produkt?
- Klademe nějaká omezení na produkt? Co musí splňovat? Proč? (Buďte konkrétní!!!)
- Jaké prostředky jsme použili?
- Popis výsledku
- Jaké jsou základní součásti produktu?
- K jakým výsledkům jste dospěli?
- Do jaké fáze původně plánovaného rozsahu se podařilo dojít?
- Splnili jste základní prototyp?
- Zvládli jste vyřešit některá rozšíření? Která?
- Narazili jste na neočekávané problémy? Jaká řešení jste nalezli?
- Praktické nasazení
- Je výsledný produkt někde používán v praxi?
- Je takové použití domluveno, plánováno?
- Porovnání s existujícími produkty
- Existují nějaké podobné produkty?
- V čem je projekt jiný než podobné existující produkty?
- Stručně obsah dalších kapitol
- 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
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.
Popis ř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.
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ý.
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ší.
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
- Shrňte vlastnosti výsledného produktu.
- Podařilo se nám splnit cíle projektu? Které ano a které ne? Zdůvodněte.
- Museli jsme učinit nějaké významné změny v porovnání s původní představou? Vysvětlete proč.
- Splnil produkt původní požadavky a očekávání? Pokud ne, proč? Pokud je v něčem dokonce překonal, uveďte.
- Navrhněte další možná témata případných navazujících projektů. Co by šlo dále zlepšit.
Použité zdroje
Citování zdrojů
- Použité zdroje uveďte na konci práce v Seznamu použitých zdrojů.
- K citování zdrojů použijte pravidla dle normy ČSN ISO 690.
- (Při citování webových stránek NEuvádějte pouze URL adresy stránek!)
- 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í.
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.).
Neměli byste citovat zdroje, které jste nečetli!!!!
Přílohy
- Uživatelská příručka aplikace (pokud je produktem aplikace).
- Zdrojový kód. (Zvláště u rozsáhlejších projektů ale není nutné. Lze vybrat jen části, nebo kód přiložit pouze na CD).
Obsah CD
- elektronická podoba textu práce
- kompletní zdrojové kódy
- skript pro vytvoření databáze, pokud je potřeba
- hesla a přihlašovací jména účtů pro vyzkoušení aplikace
