Popis:
S akoukoľvek dokumentáciou sa už určite stretol každý z nás. Napríklad, ak si kúpime umývačku riadu alebo práčku, každý z nás si musí najskôr prečítať používateľskú príručku. Z používateľskej príručky sa dozvieme ako daný výrobok správne zložiť, ako ho používať, aké ma funkcie a ako s ním správne zaobchádzať. Ďalej po nej vždy siahneme vtedy ak sa vyskytne nejaký problém, s ktorým si nevieme dať rady. Vtedy každý užívateľ uvíta prehľadnú príručku obsahujúcu aj FAQ.
Dokumentácia je kľúčový prvok najmä u softvérových projektov. Softvérovú dokumentáciu by mal obsahovať každý softvér. Dá sa povedať, že dokumentácia sčasti odzrkadľuje kvalitu celého výrobku. Však, na čo je používateľovi softvér, ktorý napríklad
nevie používať, nepozná jeho výhody, kvality a celkový prínos pre jeho prácu alebo užívanie? Medzi jej základný cieľ patrí uľahčiť prácu s novým produktom alebo technológiou používateľovi.
Obyčajní používatelia, ktorí si stiahnu alebo kúpia nejaký softvérový produkt
len zriedka čítajú jeho dokumentáciu. Po dokumentácii však nutne siahnu v prípade ak softvér nefunguje, nevedia s ním zaobchádzať alebo sa vyskytne nejaký iný problém, s ktorým si nevedia rady.
Kľúčové slová:
dokumentácia v projekte
technická dokumentácia
manažérska dokumentácia
používateľská dokumentácia
vývojárska dokumentácia
Obsah:
- OBSAH
ÚVOD 2
1 Manažovanie dokumentácie 3
2 Technická Dokumentácia 3
3 Dôležité časti dokumentácie 4
4 Vývojárska dokumentácia 4
5 Formy dodania, zverejnenia a sprístupnenia dokumentácie 5
ZÁVER 6
Použitá literatúra 7