Zásady tvorby dokumentace


Textová dokumentace řešení daného problému, protokol, seminární bakalářská nebo diplomová práce, . . . by měla obsahovat následující části a být zpracována následujícím způsobem.

 

 

 


[ad#obsah]

 

Titulní stránka – obsahuje identifikační údaje

 

Poděkování

 

Obsah – členění a číslování kapitol

 

Úvod – stručný a jasný přehled o tom, čeho se dokumentace týká a jak je členěna. Má být napsán tak, aby čtenář už dál nemusel dokumentaci číst a přesto získal přehled o dané dokumentaci

 

Zadání – co a v jakém rozsahu se bude zpracovávat musí být v zadání zcela jednoznačně uvedeno

 

Analýza problému a principy řešení – stručná charakteristika řešeného problému, obecné principy a metody řešení

 

Řešení – výběr metody řešení
Stručný, věcně správný popis v souvislých větách.
Obrázek, tabulka, schéma, … musí být číslovány a mít stručný popis.
U převzatých obrázků, tabulek, grafů, … je nutné uvést odkaz na zdroj, ze kterého bylo čerpáno.

 

Závěr – shrnutí výsledků řešení, problémy, které vznikly při řešení, atd.

 

Rezultát (výsledek) místo závěru – umísťujeme za zadání musí dát odpověď na požadavky dané v zadání.
(V závěru i v rezultátu předpokládáme, že čtenář nečetl celou práci, ale četl jen úvod nebo zadání.)
(V případě, že píšeme Úvod plus Závěr, vynecháváme Zadání a Rezultát. A obráceně.)

 

Seznam literatury – uvedeme knihy, články v časopisech, adresy z internetu, … ze kterých bylo při zpracování tématu čerpáno nebo citováno.

 


Napsat komentář