Osnova dokumentace maturitní práce
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 souvislým textem očekávaný průběh Vašeho projektu:
- Co je cílem projektu?
- fungující program?
- porovnání metod?
- vyzkoušení postupu, technologie, nástroje,...?
- ...
- Jaké jsou požadavky na výsledný produkt?
- Klademe nějaká omezení na produkt? Co musí splňovat? Proč? (Buďte konkrétní!!!)
- Jaké prostředky chceme používat?
- Popis výsledku
- Jaké jsou základní součásti produktu?
- Popište základní fáze práce: očekávaný harmonogram.
- Pokud to lze, popište:
- vlastnosti základního prototypu produktu: co je třeba jistě dokončit. Popis součástí, které jsou nezbytně nutné k tomu, aby vůbec mohl být produkt nějak použit.
- základní verzi produktu: co předpokládáte, že bude produkt na konci práce obsahovat, pokud vše půjde podle plánu,
- případná rozšíření, která jsou možná a která by zlepšíla fungování produktu. Vzhledem k časovým možnostem projektu se k těmto rozšířením nejspíš nedostanete. Mohou být ale použity například jako další projekty, které budou váš projekt rozvíjet.
- K čemu to bude?
- Bude výsledný produkt někde používán v praxi?
- Porovnání s existujícími produkty
- Existují nějaké podobné produkty?
- V čem bude projekt jiný než podobné existující produkty?
- Co se na projektu mám naučit?
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, jejichž význam není z názvu 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.
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
