Technicka dokumentace v Confluence

200strankovy Word dokument, ktery se napise na zacatku a nikdy neaktualizuje, je zbytecny. Confluence nam pomaha delat dokumentaci jinak.

Proc Confluence¶

Word v SVN: merge konflikty, binare, nejasna verze. Confluence: editace v prohlizeci, historie, komentare, JIRA integrace.

Struktura¶

ADR (Architecture Decision Records), deployment guide, runbook pro ops, API dokumentace. ADR format: kontext, rozhodnuti, dusledky.

Living documents¶

Dokumentujte rozhodnuti, ne stav. Stav se meni rychle — rozhodnuti jsou cenne dlouhodobe.

Boj s neakualnosti¶

Last reviewed datum na kazde strance. Kvartalni review. Page expiry plugin upozorni po 6 mesicich bez aktualizace.

Zaverem¶

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