====== Dokumentace ======

**Dokumentace** je soubor písemných informací, které popisují vlastnosti, fungování, vývoj a správu produktu nebo systému. V týmovém prostředí slouží jako „sdílená paměť“, která zajišťuje, že důležité informace nejsou vázány pouze na konkrétní osoby.

===== Typy dokumentace =====
V rámci IT a projektového řízení se dokumentace nejčastěji dělí do následujících kategorií:

  * **Projektová dokumentace:** Plány, časové osy, analýzy rizik a zápisy z porad (často spravováno v [[Confluence]]).
  * **Technická/Systémová dokumentace:** Popis architektury, kódu, databázových schémat a API. Určeno pro vývojáře a správce.
  * **Uživatelská dokumentace:** Návody k použití, příručky a FAQ pro koncové uživatele.
  * **Procesní dokumentace:** Definice vnitrofiremních postupů (např. „Jak schvalovat dovolenou“ nebo „Onboarding nováčka“).

===== Proč je dokumentace důležitá? =====
Kvalitní dokumentace přímo ovlivňuje efektivitu týmu:
  * **Zastupitelnost:** Umožňuje snadnější předání práce v případě nemoci nebo odchodu člena týmu.
  * **Snížení chybovosti:** Jasně definované postupy eliminují improvizaci a omyly.
  * **Onboarding:** Noví zaměstnanci se díky dokumentaci rychleji zaučí a zapojí do procesu.
  * **Historický kontext:** Pomáhá pochopit, proč byla určitá rozhodnutí v minulosti učiněna.

===== Principy dobré dokumentace =====
Aby dokumentace plnila svůj účel, měla by splňovat tato kritéria:
^ Kritérium ^ Popis ^
| **Aktuálnost** | Zastaralá dokumentace je nebezpečnější než žádná. Musí se pravidelně revidovat. |
| **Dostupnost** | Musí být snadno dohledatelná pro všechny, kteří ji potřebují (např. pomocí fulltextového vyhledávání). |
| **Srozumitelnost** | Psaná jazykem odpovídajícím cílové skupině (technická vs. byznysová). |
| **Struktura** | Logické členění pomocí nadpisů, seznamů a odkazů. |

===== Nástroje pro správu dokumentace =====
V moderních týmech se k dokumentaci využívají specializované nástroje:
  * **[[Confluence]] / DokuWiki:** Ideální pro textovou a znalostní bázi.
  * **Swagger / Postman:** Pro automatizovanou dokumentaci API.
  * **README soubory:** Dokumentace přímo u zdrojového kódu (Git).

> **Pravidlo:** Pokud musíte něco vysvětlovat dvakrát, je čas to dokumentovat.

---
**Související stránky:** [[Atlassian]], [[Confluence]], [[Jira]], [[Knihovna procesů]]