Osnova dokumentace maturitní práce

Verze z 16. 3. 2012, 14:49 (zobrazit zdroj) Spravce (diskuse | příspěvky) (Doplněn odkaz na šablonu dokumentu na web školy a kapitolka o citování zdrojů.) ← Porovnání se starší verzí

Verze z 18. 3. 2012, 10:54 (zobrazit zdroj) Spravce (diskuse | příspěvky) m (Stránka Dokumentace projektu přemístěna na stránku Osnova dokumentace projektu: Pojednává o osnově, neřeší slohový styl atd.) Porovnání s novější verzí →

---

Verze z 18. 3. 2012, 10:54

Šablonu dokumentu včetně návodu naleznete na stránkách školy po přihlášení do Intranetu OA.

Obsah 1 Dokumentace projektu obecně 2 Úvod práce podrobněji 3 Stručná osnova dalších kapitol práce 3.1 Použité technologie 3.2 Popis řešení 3.3 Výsledky 3.4 Porovnání s alternativními produkty 3.5 Závěr 4 Použité zdroje 4.1 Citování zdrojů 4.2 Přebírání informací 5 Přílohy 6 Obsah CD

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)

Dále je stručně popsán obsah jednotlivých kapitol Vaší 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:
  1. 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.
  2. 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,
  3. 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.

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.

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.).

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