Technická dokumentace v Confluence

200stránkový Word dokument, který se napíše na začátku a nikdy neaktualizuje, je zbytečný. Confluence nám pomáhá dělat dokumentaci jinak.

Proc Confluence¶

Word v SVN: merge konflikty, binare, nejasna verze. Confluence: editace v prohlížeči, historie, komentáře, JIRA integrace.

Struktura¶

ADR (Architecture Decision Records), deployment guide, runbook pro ops, API dokumentace. ADR format: kontext, rozhodnutí, důsledky.

Living documents¶

Dokumentujte rozhodnutí, ne stav. Stav se meni rychle — rozhodnutí jsou cenné dlouhodobe.

Boj s neakualnosti¶

Last reviewed datum na každé stránce. Kvartální review. Page expiry plugin upozorní po 6 měsících bez aktualizace.

Závěrem¶

Sablony, ADR pattern a pravidelne review udrzi dokumentaci zivou. Dokumentujte rozhodnutí, ne stav.