dokumentácie

Dokumentácie je súbor dokumentov, ktorý sprevádza výrobok, projekt alebo proces a poskytuje informácie o jeho cieloch, štruktúre, používaní a údržbe. V slovenčine sa slovo dokumentácie používa aj ako množné meno a často opisuje súbor materiálov, ktoré zaznamenávajú súčasný stav a rozhodnutia okolo určitého systému. Dokumentácia slúži ako zdroj poznania, návod na používanie a záznam o postupoch, čo uľahčuje údržbu, školenie a súlad s požiadavkami.

Rozlišujeme rôzne typy dokumentácie: technická dokumentácia (špecifikácie, architektúra, schémy dát, inštalácia a konfigurácia), užívateľská dokumentácia (príručky, nápoveda, tutoriály), API dokumentácia a vývojárske príručky, ako aj procesná a kvalitatívna dokumentácia (postupy, evidencia zmien, protokoly o zhode). V priemysle a IT sa často kladie dôraz na dokumentáciu súladu s normami, bezpečnostné predpisy a registračné záznamy.

Štruktúra dokumentácie býva tematicky rozčlenená: prehľad, inštalácia a konfigurácia, používanie, riešenie problémov, referenčné informácie, verzie a zmeny, glosár a diagramy. Dokumenty môžu obsahovať text, diagramy a prílohy; bežne sa vytvárajú vo formátoch ako PDF, HTML alebo XML a môžu byť spravované v systémoch na správu obsahu alebo wiki. Lokalizácia a verzovanie sú tiež často súčasťou praxe.

Medzi osvedčené postupy patrí jasnosť, presnosť, úplnosť a prístupnosť, zameranie na cieľové publikum a pravidelná aktualizácia. Dôsledné verzovanie, testovanie aktuálnosti a archivácia sú kľúčové pre dlhodobú použiteľnosť dokumentácie.