Kako uporabljate AI za pisanje tehnične dokumentacije, sprememb dnevnikov in sporočil komitov?

Question

Accepted Answer

Ključno je **dati AI-ju surovo gradivo** — dejansko diff ali kodo — in zahtevati specifičen, konvencionalen format. AI je dobar pri pretvarjanju spremembe v jasno proso, vendar le če lahko vidi, kaj se je spremenilo.

## Dober delovni postopek

- **Dajte mu diff**, ne nejasnega opisa: `git diff --staged | <vaše AI orodje>`.
- **Zahtevajte znano konvencijo** — Conventional Commits (`feat:`, `fix:`, `docs:`), ali vaš slog dnevnika sprememb.
- **Pazite na natančnost in jedrnatos** — vrstica subjekta krajša od ~50 znakov, telo, ki pojasnjuje *zakaj*.
- **Preverite, da se ujema z diffom.** AI lahko izmisli spremembe, ki niso tam; preveriti morate.

## Pred / po

Leno sporočilo komita:

```text
fixed stuff
```

Po tem, ko dajete diff in zahtevate stil 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.
```

Druga različica pove ocenjevalniku *kaj* se je spremenilo in *zakaj* — veliko bolj koristno v `git log` čez šest mesecev.

## Kaj je AI dobar pri tem

- **Docstringi in READMEI** — povzeti namen in uporabo modula.
- **Dnevniki sprememb** — razvrsti komiite v razdelke Dodano / Popravljeno / Spremenjeno.
- **Sporočila komitov** — preobrazi diff v čisto, konvencionalno sporočilo.

Vedno **preberite rezultat glede na dejansko spremembo**. AI ne poznava vaše namere — le kodo, ki je bila pokazana — zato lahko napačno označi `fix` kot `feat` ali trdi stranski učinek, ki ni resničen.

## Zakaj je to pomembno

Dobra sporočila komitov in dokumentacija so način, kako va prihodnost in sodelavci razumete *zakaj* koda obstaja. AI odpravi trenje pri dobrem pisanju, vendar je natančnost na vas: samozavestno napačen dnevnik sprememb je slabši od nobenega. Dajte mu pravo vnos, zahtevajte pravo konvencijo in preverite pred komitom.