Datum poslední modifikace: 3. 2. 2012
Dokumentaci projektu můžete psát v téměř libovolném systému (pokud není ustanoveno jinak), či editoru dosažitelném v prostředí CVT.
Doporučeny jsou Microsoft Word, HTML, .mpp (MS Project), .ppt, .pdf. Důležitá je správnost a čitelnost textu. K tomu přispívá zejména gramatická správnost, rozumná vyjadřovací schopnost a přehledná struktura dokumentu. Počet stránek v tabulce uvedený je přibližný a nepočítá se do něj titulní stránka.
Dokumentace se odevzdává prostřednictvím IS FIT, dle příslušnosti k tématu/týmu.
| Dokumenty | Stran textu (cca) | šablona |
| Plán projektu - musí být vytvořen v MS Project + další požadované informace uvedené v šabloně | 2-5 | zde |
| Plán etapy | 1-2 | vytvoří tým |
| Konfigurační řízení | 2-3 | zde |
| Změnové řízení |
1-2 |
vytvoří tým |
| Texty jednotlivých kapitol | na 20 str.původního textu 8-10
str. |
|
| Výsledná publikace |
dle tématu |
|
| Záznamy o schůzkách, protokoly o ukončení etap | 2-5 |
zde |
| Zpráva o
revizích textů |
1-2 |
zde |
| Prezentace projektu |
dle tématu |
|
| Uzavření projektu, závěrečné
zhodnocení |
2-3 |
zde |
Každý dokument odevzdávaný v rámci projektu IRP bude obsahovat následující části (v uvedeném pořadí):
Obsah (pro dokumenty delší jak 3 strany)
Úvod s uvedením účelu a přehledem zbytku dokumentu; kde je nutné také uvést tabulku zkratek a odkazy na reference
Text dokumentu členěný na číslované oddíly.
Je velmi vhodné, aby všechny dokumenty
jednoho týmu měly stejnou (nebo podobnou) grafickou úpravu - titulní
stránka, použité typy písma, systém očíslování.
Vzhledově bude stejná pro všechny dokumenty. Obsahuje identifikační údaje. Název týmu je dle vaší vlastní volby na začátku semestru, Název projektu podle zadání, Zodpovědný Autor dokumentu, případně spoluautoři, Datum vytvoření, Název dokumentu, např. "Plán projektu".
Pokud bude dokument produktem jiného systému (MS Project), je nutné dbát na to, aby výše uvedené informace byly na vhodném místě v dokumentu zaznamenány.
Možný vzor obsahu titulní stránky dokumentu:
Fakulta informačních
technologií
Ústav informačních systémů
Řízení projektů
informačních systémů
<Název projektu>
<Název týmu>
<Autoři dokumentu>
<Datum>
<Název dokumentu>
Jako (spolu)autoři budou uvedeni jen ti členové týmu, kteří se na přípravě dokumentu aktivně podíleli; za jménem člena, který je za dokument zodpovědný jako "manažer fáze", bude uvedena příslušná indikace.
Standardní obsah dokumentu; úroveň detailu (zda budou uvedeny sekce N nebo i N.N nebo dokonce N.N.N) zvolte vhodně podle délky a složitosti dokumentu. Pokud dokument obsahuje množství obrázků a/nebo tabulek, je vhodné vytvořit a za obsah připojit také seznam těchto elementů.
Stručný a jasný přehled, čeho se dokument týká a jaké má části; nutnou součástí každého dokumentu. Stačí dva, maximálně tři odstavce; mají být napsány tak, aby nemusel čtenář už dál číst a přesto měl přehled o celém dokumentu.
Pokud se jedná o technický dokument,
hemžící se zkratkami a akronymy, je nutné uvést zde i vysvětlující
tabulku (zkratka, plný text).
Čleňte jej do očíslovaných sekcí (např. 1. Úvod) a podsekcí (např. 1.2 Použité nástroje) - číslování usnadňuje orientaci a odkazy. Taktéž číslujte obrázky, diagramy a tabulky, podle vhodného systému konzistentně uplatňovaného. Používejte jednotný font.
Soustřeďte se především na obsah. Nerozlévejte se do epické šíře, pište stručně a jasně, ale s uvedením všech důležitých informací.
Pokud se jedná o velmi dlouhý dokument a/nebo členitý dokument, je dobré mít na konci rejstřík (neboli index), jako je v každé dobré technické knize.
Požadovaná dokumentace nebude úplným plánem revizí, cílem je pokrýt nejpodstatnější informace pro specifikaci a výsledky revizí.
!!! Nezapomeňte je uvést do plánu projektu !!!Odevzdávání
výsledného produktu
Veškerá definitivní dokumentace projektu včetně vytvořeného produktu
(zdrojové texty) bude vhodně strukturována do adresářů a odevzdána na
CD
(prázdné médium CD si může vedoucí týmu vyzvednout u Kreslíkové).