Osnova dokumentace maturitní práce

Z MiS
(Rozdíly mezi verzemi)
Přejít na: navigace, hledání
(Dodány související stránky, Upraven vzhled poznámek.)
m (Popis řešení: Upřesnění formulace)
Řádka 69: Řádka 69:
  
 
<div class="Priklad">
 
<div class="Priklad">
Není tedy například třeba popisovat, jak funguje ve Vašem kódu podmínka <code>if</code> či cyklus <code>for</code> 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ý.
+
Není tedy například třeba popisovat, jak funguje ve Vašem kódu podmínka <code>if</code> či cyklus <code>for</code> 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ý.
 
</div>
 
</div>
  

Verze z 16. 3. 2012, 14:17

Související stránky: Harmonogram projektu

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:

  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 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?
Jaké jsou požadavky na výsledný produkt?
Popis výsledku
K čemu to bude?
Porovnání s existujícími 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, 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

Přílohy

Obsah CD

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