Aloittelija📝 Dokumentointi

Changelog-merkinnän luonti

Luo changelog-merkintä muutoksille.

Prompti

Luo changelog-merkintä seuraavalle muutokselle.

Muutokset:
[MUUTOKSET]

Versio: [VERSIO]
Päivämäärä: [PÄIVÄMÄÄRÄ]

Noudata Keep a Changelog -formaattia:
- Added (uudet ominaisuudet)
- Changed (muutokset)
- Deprecated (poistumassa)
- Removed (poistetut)
- Fixed (korjaukset)
- Security (turvallisuuspäivitykset)

Suomenkieliset vinkit

  • Suomenkielinen dokumentaatio on arvokasta suomalaisille tiimeille
  • Lisää 'vastaa suomeksi' promptin loppuun jos AI vastaa englanniksi
  • Voit sekoittaa suomea ja englantia — teknisiä termejä ei tarvitse kääntää

Muuttujat

Korvaa nämä hakasulkeissa olevat muuttujat omilla tiedoillasi:

  • [MUUTOKSET]
  • [VERSIO]
  • [PÄIVÄMÄÄRÄ]

Esimerkki

Täytetty prompti

Luo changelog-merkintä seuraavalle muutokselle.

Muutokset:
- Lisätty uusi käyttäjäprofiilisivu
- Korjattu kirjautumisen bugi joka aiheutti session katoamisen
- Päivitetty React 18:sta 19:ään
- Poistettu vanha käyttäjähallinta-API
- Parannettu suorituskykyä kuvien latauksessa

Versio: 2.1.0
Päivämäärä: 2025-01-15

Noudata Keep a Changelog -formaattia:
- Added (uudet ominaisuudet)
- Changed (muutokset)
- Deprecated (poistumassa)
- Removed (poistetut)
- Fixed (korjaukset)
- Security (turvallisuuspäivitykset)

Tulos

Formatoitu changelog-merkintä.

Vinkit

  • Listaa kaikki muutokset
  • Mainitse versio ja päivämäärä
  • Käytä standardiformaattia

Milloin käyttää

  • Julkaiset uuden version
  • Dokumentoit muutoksia
  • Avoimen lähdekoodin projekti

Lisää prompteja

Selaa kaikkia dokumentointi prompteja tai tutustu muihin kategorioihin.