Úvodné kapitoly do témy ako a prečo písať dokumentáciu a príručky
Séria: Ako písať dokumentáciu a manuály v IT projekte
V mnohých firmách existuje dokumentácia len na papieri.
Formálne je potrebná, ale v praxi ju nikto nepíše.
Keď sa otvorí téma dokumentácie, reakcie bývajú podobné:
„Nemáme na to čas.“
„Najprv treba dokončiť funkcionalitu.“
„To dopíšeme neskôr.“
„Veď to máme v kóde.“…
Séria: Ako písať dokumentáciu a manuály v IT projekte
V mnohých firmách vyzerá realita približne takto:
Dokumentácia?
Používateľská sa dopíše o niekoľko verzií neskôr, keď zákazník začne urgovať.
Administrátorská je často stará niekoľko rokov.
Technická dokumentácia nevzniká vôbec.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
V predchádzajúcich článkoch sme pomenovali dva problémy:
Najčastejšie sa miešajú tieto veci:
Výsledok je jeden veľký dokument, ktorý síce existuje, ale nikto sa v ňom nevie orientovať.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
V predchádzajúcich článkoch sme si ukázali dve veci:
Teraz sa pozrime na problém, ktorý je menej viditeľný – ale v produktových firmách veľmi častý.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
V prvom článku série „Nie je manuál ako manuál“ som pomenovala problém miešania cieľových skupín v dokumentácii.
Dnes sa posunieme o krok ďalej.
Čo sa deje vo firmách, kde dokumentácia neexistuje vôbec?
Príde nový kolega.…
(Web verzia – rozšírený článok do série „Dokumentácia ako súčasť kvality produktu“)
Vo firme zaznie veta:
„Treba napísať manuál.“
Nikto sa nepýta:
Výsledok?
Jeden dokument, ktorý obsahuje:
