Projektová dokumentace pro tvorbu internetových aplikací Tomáš Kuthan PhDr. Milan Novák, Ph.D. Školní rok: 2008-09
Abstrakt Bakalářská práce stanovuje vzor pro vytváření projektové dokumentace internetových projektů včetně ukázek na konkrétním příkladě a nasazení v praxi. Teoretická část popisuje základní pravidla, která by měla být dodržována při tvorbě dokumentace, vzorové dokumenty a obecný model postupů. Naproti tomu praktická část se věnuje aplikování teorie do praxe. Jako vzorový příklad byl použit projekt Informační a aplikační portál společnosti Robert Bosch spol. s r.o. České Budějovice, na kterém pracuji jako hlavní programátor. Abstract The bachelor work gives the pattern for the creation of a project documentation of internet projects including samples on a concrete example and use in practice. The theoretic part describes basic rules which should be followed during the creation of documentation, sample documents and the basic pattern of technique. On the other hand the practical part attends to application of the theory to the practice. As a example was used the project Informative and application portal of the company Robert Bosch s.r.o České Budějovice, where I work as a head programmer. Klíčová slova dokumentace, projekty, internet, postupy Keywords documentation, projects, internet, procedures
Zadání práce Vytvoření vzorové projektové dokumentace se specifikací na internetové projekty. Součástí bude případová studie přípravy a řešení konkrétního projektu. Obsahem řešení je komplexní vzor dílčích dokumentů s využitím moderních návrhových nástrojů. Výsledkem bude také obecný model postupů při realizaci internetových projektů s využitím návrhových vzorů UML.
Úvod Úvod do problematiky Prvním problém, který je nutné vyřešit, je definice pojmu projektové dokumentace. Běžně je možné se setkat s tím, že se jedná o určitý popis toho, co daný program či aplikace dělá. Ale tato odpověď je pravdivá jen z poloviny. Pod projektovou dokumentací je nutné si představit i samotné zaznamenávání průběhu projektu, stanovování cílů, rozdělování úkolů a mnoho dalšího. Bohužel je v dnešní době, obzvláště u internetových projektů, problém, že dokumentační část práce na projektu je zanedbávána a to na všech úrovních projektového týmu, který může být tvořen manažerem, vedoucím projektu, analytiky, designéry, programátory a dalšími členy. Problém může spočívat zejména v tom, že není obecný dostupný žádný model postupů a ani základní přehled dokumentů, které by neměli při práci na projektu chybět. Cíle práce Bakalářská práce má za cíl zahrnout část problematiky, která uspokojí členy projektového týmu ve všech úrovních. V každém týmu je nutné přesně definovat pozici jednotlivých členů a pozicím přidělit konkrétní úkoly. Stejně tak je nutné, aby z pohledu každé pozice byla zpracována taková dokumentace, aby bylo možné předat úkoly či se později vrátit ke konkrétním úkonům a vědět, jaké další kroky budou následovat. Práce popíše základní pravidla a obecný model postupů při práci v projektovém týmu a definuje tak jasnou strukturu pravidla práce na internetových projektech. Součástí musí být taktéž přehled kompletní projektové dokumentace a její vzorové vypracování. Samotný model postupů a struktura jednotlivých dokumentačních souborů se může lišit v závislosti na kategorii daného projektu. Proto si práce také bere za cíl definici jednotlivých kategorií internetových projektů. Přehled literatury Česky psané literatury, která je přímo zaměřena na problém projektové dokumentace, je nedostatek, proto je nutné sáhnout zejména po anglicky psaných textech jako základní stavební kámen lze použít knihu Neobyčejně užitečná kniha o webu [1]. Bohužel ani tato kniha neobsahuje komplexní pojetí problému. Věnuje popisu vzniku projektu od samého začátku a obsahuje takové části, jako je rozdělení úkolů na nově vznikajícím projektu, definice cílů, ale také samotný návrh, vývoj, testování a činnosti spojené s následným provozováním projektu. Publikace je ale pojata
spíše pro tu část lidí, kteří nepatří přímo do vývojového týmu, jako jsou například manažeři. Tato práce má za cíl uspokojit členy projektového týmu ve všech úrovních. Jako literární zdroj pro pochopení UML lze použít [2]. Dalším zajímavým zdrojem je pak domovská stránka projektu WebML [3]. Analýza problému Východiska řešení Jak již bylo uvedeno v přehledu literatury, pro tento konkrétní problém v současné době nebylo žádné komplexní řešení v českém jazyce publikováno a existují pouze částečná řešení. Základem se tedy pro řešení problémů stane zejména zahraniční literatura přímo zaměřena na tento komplexní problém a také částečná řešení, která jsou dostupná i v českém jazyce. Jako další pohled na věc budou použity praktické znalosti a zkušenosti z práce v projektovém týmu. Metodika Vzhledem k dostupnosti určitých zdrojů informací a vlastním zkušenostem bude použita komparativní metoda. Tento způsob by měl mít za výsledek ideální vyřešení problému, který by díky tomu měl být zároveň maximálně univerzální. Co je již hotové Práce na komparačním výzkumu Definice dílčích cílů Struktura Dokumentace vzorového projektu Co je třeba ještě udělat Zpracování teoretické části Upravení dokumentů pro obecné použití Porovnání teorie a praxe
Seznam literatury [1]COHENOVÁ, June. Neobyčejně užitečná kniha o webu. Jan Kuklínek. Praha : SoftPress, 2004. 372 s. ISBN 80-86497-63-1. [2]IBM Rational Software [online]. 2008 [cit. 2008-12-03]. Dostupný z WWW: <http://www.rational.com>. [3]Webml.org : web modeling language [online]. 2008 [cit. 2008-12-03]. Dostupný z WWW: <http://www.webml.org>.