Kaip naudoti dirbtinį intelektą techniniams dokumentams, pakeitimų žurnaluose ir commit žinutėms rašyti?

Question

Accepted Answer

Svarbiausia — **duoti AI žaliavą** — faktinį skirtumą (diff) arba kodą — ir paprašyti konkretaus, standartizuoto formato. AI gerai paverčia pakeitimą aiškiu tekstu, bet tik jei mato, kas pasikeitė.

## Gera darbo eiga

- **Paduokite jam diff**, ne miglotą aprašymą: `git diff --staged | <jūsų AI įrankis>`.
- **Paprašykite žinomo standarto** — Conventional Commits (`feat:`, `fix:`, `docs:`), arba jūsų žurnalo stilio.
- **Laikykitės tikslios ir glaustės** — tema trumpesnė nei ~50 simbolių, tekstas paaiškinantis *kodėl*.
- **Patikrinkite, ar atitinka diff.** AI gali sugalvoti pakeitimų, kurių nėra; jūs turite patikrinti.

## Prieš / po

Tingusu parašyta commit žinutė:

```text
fixed stuff
```

Pasiuntus diff ir paprašius Conventional Commit stilio:

```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.
```

Antras variantas skaitytojui parodo *ką* pasikeitė ir *kodėl* — daug naudingiau `git log` žiūrint po šešių mėnesių.

## Kur AI čia patinka

- **Docstringai ir README failai** — susumuoti modulio paskirtį ir naudojimą.
- **Pakeitimų žurnalai** — sugrupuoti commits į Added / Fixed / Changed sekcijas.
- **Commit žinutės** — paversti diff į švarias, standartizuotas žinutes.

Visada **perskaitykite rezultatą pagal faktinį pakeitimą**. AI nežino jūsų ketinimo — tik kodą, kurį jam rodėte — todėl gali klaidingai įvardyti `fix` kaip `feat` arba teigti šalutinį efektą, kurio nėra.

## Kodėl tai svarbu

Geros commit žinutės ir dokumentacija — tai kaip jūsų ateities aš ir komandos draugai supranta *kodėl* kodas egzistuoja. AI šalina žinučių rašymo gerai pasipriešinimą, bet tikslumas — jūsų pareiga: pasitikinti klaidinga žinute blogesnis nei jos nebuvimas. Duokite jam realias įvestis, reikalaukite realaus standarto ir patikrinkite prieš commit'inant.