Jak používáte AI k psaní technické dokumentace, changelogů a commit zpráv?

Question

Accepted Answer

Klíčem je **poskytnout AI surový materiál** — skutečný diff nebo kód — a požádat o specifický, standardní formát. AI je dobrá na převedení změny do jasného textu, ale pouze pokud vidí, co se změnilo.

## Dobrý workflow

- **Předajte mu diff**, ne vágní popis: `git diff --staged | <váš AI nástroj>`.
- **Požadujte známou konvenci** — Conventional Commits (`feat:`, `fix:`, `docs:`), nebo váš styl changelog.
- **Udržujte to přesné a stručné** — subject line pod ~50 znaků, body vysvětlující *proč*.
- **Ověřte, že to odpovídá diffu.** AI může vymyslet změny, které tam nejsou; musíte si to zkontrolovat.

## Před / po

Lenivá commit zpráva:

```text
fixed stuff
```

Po podání diffu a požádání o styl Conventional Commit:

```text
fix(auth): reject expired tokens in session middleware

The middleware only checked token signature, not expiry, so expired
sessions stayed valid. Added an `exp` claim check that returns 401.
```

Druhá verze říká reviewerovi *co* se změnilo a *proč* — mnohem užitečnější v `git log` za šest měsíců.

## V čem je AI dobrá

- **Docstrings a READMEs** — shrnutí účelu a použití modulu.
- **Changelogy** — seskupení commitů do sekcí Added / Fixed / Changed.
- **Commit zprávy** — převedení diffu na čistou, standardní zprávu.

Vždy **si přečtěte výsledek oproti skutečné změně**. AI nezná váš záměr — zná jen kód, který jí byl předložen — takže může špatně označit `fix` jako `feat` nebo tvrdit vedlejší efekt, který neexistuje.

## Proč to má smysl

Dobré commit zprávy a dokumentace jsou tím, jak si budoucí vy a vaši kolegové uvědomíte *proč* kód existuje. AI odstraňuje tření při jejich dobrém psaní, ale přesnost je na vás: sebevědomě špatný changelog je horší než žádný. Poskytněte mu skutečný vstup, vyžadujte skutečnou konvenci a ověřte si to před commitnutím.