Späť na hlavnú stránku

Guidelines

Kvoli jednotnosti a tým aj uľahčeniu výmeny dokumentov a zdrojov navrhujem vytvoriť nejaké smernice, ktorých sa treba pridržiavať. Na túto stránku pridávajte smernice, ktoré by mali byť dodržiavané - či už ide o templaty dokumentov, alebo zoznamy používaných programov, ... Pred tým ako niekto vyprodukuje nejakú smernicu, prosím poraďte sa so zbytkom tímu prostredníctvom mailinglistu ( tp@alzheimer.kmit.sk )

Zmernice zahŕňajú nasledujúce časti:

• Práca s RCS - Subversion
• Práca s dokumentami
• Práca so systémom TRAC - issue tracker

TODO - dokončiť rozdelenie

Ukladanie vysledkov práce

Všetko čo vyprodukujete a nenachádza sa tu vo wiki ukladajte do SVN. Organizácia je asi nasledovná. Predpokladom vytvorenia je task v TRACe, jednotlivé tasky su asociované s komponentom. Každý komponent má vytvorené repository. Následne ukladajte tie veci tam.

Organizácia SVN repository

Každý objekt (v TRACe komponent) má vytvorený adresár. Ak nemá môžete vytvoriť.

Do SVN ukladáme vo všeobecnosti 2 typy objektov:

• Objekty, ktoré potrebujú mať evidované verzie a je potrebný prístup k roznym verziám
• Objekty, kde nie je potrebné mať verzie.

Objekty s evidovaním verzií

Adresárová štruktúra je nasledovná

repository

 |

 +- komponent

     |

     +-trunk      //obsahuje aktuálnu vývojovú verziu

     +-branches   //obsahuje lokálne verzie - napr. na ktorej pracujem len ja.

       +-moja verzia

       +-...

     +-tags       //obsahuje staršie verzie - podľa dohody. Pravdepodobne budú verzie asociované s míľnikmi

       +-ver1.0

Takto budú ukladané určite zdrojové kódy a zrejme aj dokumenty - tak aby reflektovali zmeny v zdrojákoch.

Objekty bez potreby evidencie verzií

Ide o objekty ako šablóny dokumentov, zápisy zo schodze a tak. Nemajú záväznú adresárovú štruktúru.

Tvorba dokumentov

Šablóny je možné nájsť v SVN repository: source:dokumenty/template

• Kancelársky balík OpenOffice 2
  • Dôvody prečo je tento balík uprednostnený pred MS Office sú :
    • Dostupnosť
    • Export do PDF - možnosť priamej tvorby dokumentov vhodných pre umiestnenie na web
    • Lepšia a predvídateľná práca so štýlmi
  • Pred začatím práce na dokumente, ktorý je uložený v repository akceptujte všetky zmeny a povoľte záznam zmien. Je tak možné sledovať zmeny medzi jednotlivými verziami dokumentov. Pre ilustráciu ako je to možné spravit v OO2 je priložený obrázok:
    
    
    
    
    
    
• RCS - Použité bude Subversion
  • Dôvody sú prítomnosť na serveri, jednoduchá práca a podpora viacerých vývojových prostredí
  • viac info na http://subversion.tigris.org , alebo na http://decef.elf.stuba.sk/~db20077/subversion/
  • Pre väčší používateľský komfort si Windowsaci možu nainštalovat TortoiseSVN. Je to taky malý zlatý programček, ktorý integruje Subversion do explorera.

Práca s taskami (Ticket)

Keď vytvárate nový ticket snažte sa ho rozumným spôsobom pomenovať. Následne názov možeme priamo použiť v dokumente a je možné, že budeme zverejnovať úlohy na stránke automatizovane.

Do popisu sa pokúste dať čo najviac informácií potrebných na realizáciu. V prípade, že ide o encyklopedické znalosti (rozumej veci, ktoré sa môžu zísť ešte pri inej priležitosti) vytvorte wiki stránku a umiestnite tam odkaz.

Vyriešenie taskov. Ked chcete označiť ticket (task) ako vyriešený, nastavujte resolution status. V prípade nejednoznačného riešenia (napr. task : vylepšiť design) - tj. nie je celkom isté, či je už tá úloha skončená, alebo potrebuje, aby ju niekto iný skontroloval (napr. opravil som niečo v kóde, ale nie som si istý, či som tým niečo iné nepokazil), nastavujte status na to be verified. Tieto tasky je potom možné ľahko vyhľadať.

Pre ostatné tasky dávajte resolution status podľa aktuálneho stavu. Najčastejší bude asi fix.