Promptit dokumentaation ja kommenttien kirjoittamiseen.
16 promptia
Lisää JSDoc-dokumentaatio funktioille ja moduuleille niin, että IDE näyttää hyödylliset vihjeet. Kattaa parametrit, palautusarvot ja käyttöesimerkit.
Luo kattava README-tiedosto projektille.
Luo kattava API-dokumentaatio, joka kattaa endpointit, parametrit, vastaukset ja esimerkit — niin että tiimin jäsenet ja ulkoiset kehittäjät pääsevät alkuun ilman lisäkysymyksiä.
Lisää selkeät kommentit monimutkaiseen koodiin.
Luo selkeä changelog-merkintä joka kertoo mitä muuttui, miksi ja miten se vaikuttaa käyttäjiin. Noudattaa Keep a Changelog -muotoa ja semantic versioning -periaatteita.
Dokumentoi sovelluksen arkkitehtuuri niin, että uusi kehittäjä ymmärtää kokonaisuuden. Kattaa kansiorakenteen, datavirran, riippuvuudet ja keskeiset suunnittelupäätökset.
Luo Storybook-story komponentille eri tiloilla ja variaatioilla. Saat dokumentoidun esikatselun joka helpottaa kehitystä, testausta ja tiimin välistä kommunikaatiota.
Kirjoita selkeä ja informatiivinen commit-viesti.
Dokumentoi projektin ympäristömuuttujat.
Kirjoita selkeä PR-kuvaus koodimuutoksille.
Luo selkeä virhevastausstandardi API-rajapinnoille.
Arvioi promptin laatu systemaattisesti ennen tiimijakoon vientiä.
Luo PR:stä tiivis riskikatselmus reviewerille.
Luo selkea postmortem-runko tuotantohairion jalkeen.
Muunna commitit ja PR-muutokset selkeiksi julkaisutiedotteiksi.
Tunnista sprintin riskimallit ja tee konkreettinen parannussuunnitelma.