Aloittelija📝 Dokumentointi

Release notes -generaattori

Muunna commitit ja PR-muutokset selkeiksi julkaisutiedotteiksi.

Suora vastaus: mitä tämä sivu antaa?

Valmis promptimalli: voit kopioida sen sellaisenaan ja muokata muuttujat omaan tilanteeseen.
Nopea käyttöönotto: mukana on täytetty esimerkki ja selitys milloin promptia kannattaa käyttää.
Jos tarvitset työkalun käyttöohjeen: jatka Cursor-oppaisiin osoitteessa `/vibekoodaus/cursor`.

Prompti

Luo release notes seuraavista muutoksista.

Muutokset:
[MUUTOKSET]

Kohderyhmat:
[KOHDERYHMAT]

Tuota:
1) kayttajille suunnattu tiivistelma
2) tekninen muutoslista
3) mahdolliset breaking change -huomiot
4) suositellut jatkotoimet

Suomenkieliset vinkit

Pyydä "kayttajille" ja "kehittajille" erilliset osiot paremman luettavuuden vuoksi

Muuttujat

Korvaa nämä hakasulkeissa olevat muuttujat omilla tiedoillasi:

[MUUTOKSET]
[KOHDERYHMAT]

Esimerkki

Täytetty prompti

Luo release notes seuraavista muutoksista.

Muutokset:
Auth refactor, uusi analytics-dashboard, bugifix checkoutiin

Kohderyhmat:
Loppukayttajat, kehittajat, asiakastuki

Tulos

Saat julkaisutiedotteen, jota voi kayttaa suoraan changelogissa ja asiakasviestinnassa.

Vinkit

Erottele tekninen ja ei-tekninen viestinta
Nosta breaking change aina erikseen
Pidä tyyli lyhyena ja selkeana

Milloin käyttää

Julkaisupaeiva lahella
Muutoksia useilta tiimeilta
Tarvitaan yhdenmukaiset release notesit

Liittyvät promptit

Pull Request -kuvauksen kirjoittaminen

Kirjoita selkeä PR-kuvaus koodimuutoksille.

Rollback-päätösrunko

Tee nopea mutta perusteltu päätös rollbackista tuotantohäiriössä.

JSDoc-kommenttien lisääminen

Lisää JSDoc-dokumentaatio koodille.

Hyödyllisiä resursseja

Lisää prompteja

Selaa kaikkia dokumentointi prompteja tai tutustu muihin kategorioihin.

Kaikki dokumentointi promptit Kaikki kategoriat