Metodika dokumentácie
Počas práce na projekte vznikajú viaceré formy sprievodnej dokumentácie, ktorých jednotnú štruktúru a konzistentnosť zabezpečuje dodržiavanie tejto metodiky. Nasledovanie nižšie uvedených pravidiel je povinné pre všetkých členov tímu. V rámci dokumentácie rozoznávame generovanú technickú dokumentáciu, ktorá vzniká zo zdrojových kódov a úzko súvisí s Metodikou písania zdrojového kódu. Dokumentácia, ktorá vzniká samostatne musí dodržiavať nasledujúce pravidlá:
Štýl vytvárania dokumentácie:
Pri tvorbe sprievodných dokumentov musia byť dodržané nasledujúce pravidlá: • Pre hlavné kapitoly dokumentácie používať Nadpis 1 • Pre podkapitoly dokumentácie používať Nadpis 2 • Pre menšie obsahové jednotky používať Nadpis 3 • Pre technické časti a ukážky kódov obsiahnuté v dokumentácií používať sivé podfarbenie • Pre parametre jednotiek používať kurzívu • Typ a veľkosť písma musí zodpovedať typu vytváraného dokumentu
Zverejňovanie dokumentácie:
Všetka vytvorená dokumentácia musí byť dostupná na Wiki záložke TFS servera (https://tfs.fiit.stuba.sk:8443/tfs/StudentsProjects/Gridbox/_wiki/wikis), kde majú k nej prístup všetci členovia tímu. Pri vytváraní dokumentácie na Wiki je vyžadovaný formát Markdown, ktorý je potrebné dodržať podľa tak aby boli splnené vyššie uvedené pravidlá. Súbor musí byť vecne pomenovaný, aby z jeho názvu bolo jasné, aký obsah sa v ňom nachádza. Dokument je potrebné umiestniť do jedného z pripravených adresárov, podľa toho, akou problematikou sa zaoberá. Každý autor je povinný predtým ako nahrá svoj text si ho skontrolovať a opraviť gramatické chyby a preklepy.
Revízia dokumentácie:
V prípade, že je niektorý z vytvorených dokumentov potrebné revidovať, vykoná zodpovedný člen tímu revíziu dokumentu, pričom musí stále dodržiavať pravidlá pre dokument. V prípade, že revízia obsahuje dôležité zmeny, upovedomí o tom aj ostatných členov tímu (konkrétny spôsob a typ komunikácie podľa Metodiky komunikácie.
Formát dokumentácie:
V prípade rozsiahlejšieho dokumentu (ktorého rozsah presiahol 10, prípadne menej ak si to vyžaduje konkrétny dokument) strán je nutné na mať na začiatku vygenerovaný obsah jednotlivých častí dokumentu. Ak sa v dokumentácií vyskytujú skratky alebo pojmy, ktorých význam nie je jasný, je potrebné uviesť ich vysvetlenie.
Šablóny opakovane vytváraných dokumentov
Počas tímového projektu prebieha opakované vytváranie niektorých dokumentov. Tie musia dodržiavať šablóny uvedené nižšie.
Šablóna pre zápisnice zo stretnutí z vedúcim:
Zápisnica zo stretnutia s vedúcim dd.mm.rrrr, tím 06
Čas stretnutia: od - do vo formáte (hh:mm)
Miesto stretnutia: miesto, kde prebehlo stretnutie
Téma stretnutia: Hlavná náplň stretnutia
Zápisnicu vypracoval: meno člena tímu, ktorý zápisnicu vypracoval
Prítomní:
zoznam prítomných členov tímu na stretnutí
Neprítomní:
zoznam neprítomných členov tímu na stretnutí
Zápisy zo stretnutia:
jednotlivé zápisy zo stretnutia vymenované v bodoch
Vytvorená zápisnica je pomenovaná ako Zápisnica X - dd.mm.rrrr (kde X reprezentuje číslo zápisnice a dd.mm.rrrr dátum stretnutia, z ktorého daná zápisnica vznikla).
Šablóna retrospektívy
X. Retrospektíva dd.mm.rrrr, tím 06
Prítomní:
zoznam prítomných členov tímu na stretnutí
Neprítomní:
zoznam neprítomných členov tímu na stretnutí
S čím prestať?
zoznam toho, s čím je potrebné skončiť
S čim pokračovať?
zoznam dobrých zvykov a činností, v ktorých chceme pokračovať
Čo zlepšiť?
zoznam toho, čo je potrebné zlepšiť
Vytvorená retrospektíva je pomenovaná ako Retrospektíva X - dd.mm.rrrr (kde X reprezentuje číslo retrospektívy a dd.mm.rrrr dátum stretnutia, z ktorého daná retrospektíva vznikla).