Dokumentointi promptit

Milloin käytät näitä promptteja?

Dokumentointipromptit tuottavat ohjeita ihmisille ja tekoälylle: README-tiedostoja, koodikommentteja ja projektin ohjetiedostoja. Vibekoodauksessa dokumentaatio on myös kontekstia, jonka tekoäly lukee jokaisen istunnon alussa, joten hyvä ohjetiedosto parantaa jokaista seuraavaa vastausta.

• Projekti on toiminut jo jonkin aikaa, eikä kukaan ole kirjannut, miten se ajetaan.
• Haluat tekoälyn noudattavan samoja sääntöjä joka istunnossa, esimerkiksi CLAUDE.md-tiedoston avulla.
• Annat projektin toiselle ihmiselle tai palaat siihen pitkän tauon jälkeen.
• Rakennat API:n, jota joku muu käyttää.

Esimerkki

Tilanne: Projektista puuttuu README, ja palaat siihen kolmen kuukauden päästä.

Lue projekti ja kirjoita README.md, jossa on: mitä sovellus tekee kahdella lauseella, miten se asennetaan ja käynnistetään, mitkä ympäristömuuttujat tarvitaan (vain nimet, ei arvoja) ja miten testit ajetaan. Älä keksi ominaisuuksia, joita koodissa ei ole.

Mitä tapahtuu: README kertoo, miten projekti käynnistetään, ja sama tiedosto antaa tekoälylle kontekstin seuraavassa istunnossa. Kielto keksiä ominaisuuksia pitää dokumentaation totuudenmukaisena.

Miten hyvä prompti rakennetaan?

Kaikki tämän kategorian promptit noudattavat samaa neljän osan rakennetta. Kun jokin osa puuttuu, tekoäly täyttää aukon arvauksella.

1. Tavoite: mitä haluat lopputulokseksi, yhdellä tai kahdella lauseella.
2. Konteksti: mitkä tiedostot, sivut tai virheilmoitukset liittyvät tehtävään.
3. Rajaus: mitä tekoäly ei saa muuttaa, kuten ulkoasu, testit tai muut tiedostot.
4. Tarkistus: miten tiedät, että tehtävä onnistui, esimerkiksi testit menevät läpi tai sivu näyttää oikean summan.

Yleisimmät virheet

• Dokumentaatio, joka kuvaa toiveita. Tekoäly kirjoittaa helposti ominaisuuksia, joita ei ole, jos et kiellä sitä.
• Liian pitkä ohjetiedosto. Tekoäly lukee sen joka istunnossa, joten pidä se lyhyenä ja siirrä harvoin tarvittavat tiedot omiin tiedostoihinsa.
• Vanhentunut README. Väärä ohje on pahempi kuin puuttuva, koska sekä ihminen että tekoäly luottavat siihen.

Vinkit

• Pyydä dokumentoimaan vain se, mikä koodissa jo on.
• Älä koskaan laita salasanoja tai API-avaimia dokumentaatioon, vain muuttujien nimet.
• Päivitä dokumentaatio samassa pyynnössä, jossa toiminta muuttuu.

Liittyvät sanaston termit: Konteksti, Prompt, API, Ympäristömuuttujat, System prompt