Spravovanie ulozista s dokumentaciou

Motivacia

Zmyslom zavedenia nizsie spominanych pravidiel je dosiahnut udrzatelny system dokumentacie tykajucej sa vyvoja produktu. Udrzatelny system v takom zmysle, ze casom, aj pridavanim suborov, vnizkanim novych projektov ci produktov bude uloziste dokumentov vyznamnym prinosom pri studiu vlastnosti komplexneho systemu. Tomu ma napomoct aj vyhladavaci system nad dokumentaciou. Ak chceme pouzivat vyhladavanie musime zabezpecit aby sa relevantny subor nachadzal vo vyhladavaci aktualny a za normalnych okolnosti len raz. Tiez je potrebne zabezpecit castu aktualizaciu vyhladavacej databazy, co je mozne iba pri rozumnom pocte suborov.

Uloziste produktovej dokumentacie

Produktova dokumentacia sa nachadza na cestach:

(1) //192.168.241.25/DokumentaciaTD/VyvojovyUsek
(2) //192.168.241.25/DokumentaciaTD/VyvojovyUsekArchiv

Pravidla

  • Do adresara (1) sa uklada iba aktualna dokumentacia. (ZIADNA starsia zaloha dokumentu. Teda ani /old, /archiv alebo ani viac verzii dokumentu)
  • Adresar (1) je strukturovany podla produktov
  • V strukture (1) sa uklada IBA a len vseobecna produktova dokumentacia. Teda funkcionalita ktora nie je viazana na konkretny projekt alebo zakaznika. (Neznamena to, ze sa tam nemoze dat vseobecna funkcionalita ktora vznikla z projektu, alebo pre zakaznika. Musi byt ale vseobecne platna).
  • V strukture adresara (1) sa neukladaju ine typy suborov ako dokumentacia. (Teda ziadne binarky, zdrojove subory, data pre strojceky, exe, dll, .so, …)
  • Zalohy a archiv dokumentov sa uklada do adresara (2)
  • Adresar (2) je strukturovany podla presnej kopie (1:1) s adresarovou strukturou (1)
  • Kazdy subor ktory sa v (2) najde mimo strukturu bude moct byt automatickym skriptom zmazany
  • Subor, ktory sa presunie zo starsich ulozist do (1), odporucam premenovat: napr. “AndroidRevizorskaCitacka” na “_TMP_DOKUMENTACIA_TD_AndroidRevizorskaCitacka” aby bolo jasne, ze aktualna verzia sa tam uz nenachadza.
  • Ak sa upravuje dokument na starsom ulozisti odporucam zvazit presunutie do struktury (1), ktora sa indexuje pre vyhladavanie.

FAQ

  • Kam ukladat projektovu dokumentaciu?

Projektova dokumentacia ohladom dopravy by mala byt ulozena v priecinku //192.168.241.25/DokumentaciaTD/TPUsek/Doprava/Projekty. Adekvatne aj ine oblasti. Mali by tam byt ulozene len dokumenty v zavislosti na pravidlach prevadzkoveho useku.

  • Kam ukladat data pre strojceky?

Z pohladu vyvoja do a) prisluchajucej chyby na helpdesku, b) prisluchajucej ulohy na redmine tasku. Z pohladu projektu podla pravidiel prevadzkoveho useku.

  • Chcem opravit chybu v dokumente, ktory je ale v adresari Projekty_ISO. Co mam urobit?

Vzdy upravovat iba najnovsiu verziu dokumentu (overit ci nie je ulozena na (1)). Je potrebne zvazit ci je dokument mozne presunut do struktury (1). Ak nie vyrobit novy subor podla konvencie v adresari. Ak to mozne je tak prekopirovat najnovsiu verziu do (1), vsetky starsie verzie do (2) a premenovat adresar s prefixom _TMP_DOKUMENTACIA_TD_.

 
dev_doc/doc_maintenance.txt · Last modified: 2016/08/05 13:05 by 192.168.242.36
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki