Aloittelija📝 Dokumentointi

README-tiedoston luonti

Luo kattava README-tiedosto projektille.

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 README.md tiedosto projektille.

Projektin tiedot:
- Nimi: [NIMI]
- Kuvaus: [KUVAUS]
- Teknologiat: [TEKNOLOGIAT]

Sisällytä:
- Projektin kuvaus
- Asennus ja käyttöönotto
- Käyttöohjeet
- Ympäristömuuttujat
- Kehitysympäristön pystytys
- Testien ajaminen
- Lisenssi

Käytä selkeää rakennetta ja Markdown-muotoilua.

Suomenkieliset vinkit

Suomenkielinen dokumentaatio on arvokasta suomalaisille tiimeille
Lisää 'vastaa suomeksi' promptin loppuun jos AI vastaa englanniksi

Muuttujat

Korvaa nämä hakasulkeissa olevat muuttujat omilla tiedoillasi:

[NIMI]
[KUVAUS]
[TEKNOLOGIAT]

Esimerkki

Täytetty prompti

Luo README.md tiedosto projektille.

Projektin tiedot:
- Nimi: Vibekoodaus Blog
- Kuvaus: Blogi-sovellus vibekoodaus-aiheisille artikkeleille
- Teknologiat: Next.js, TypeScript, Tailwind CSS, Supabase

Sisällytä:
- Projektin kuvaus
- Asennus ja käyttöönotto
- Käyttöohjeet
- Ympäristömuuttujat
- Kehitysympäristön pystytys
- Testien ajaminen
- Lisenssi

Käytä selkeää rakennetta ja Markdown-muotoilua.

Tulos

Täydellinen README.md.

Vinkit

Kuvaile projekti tarkasti
Listaa kaikki teknologiat
Mieti kohderyhmä

Milloin käyttää

Uusi projekti
Avoimen lähdekoodin julkaisu
Tiimin dokumentaatio

Liittyvät promptit

JSDoc-kommenttien lisääminen

Lisää JSDoc-dokumentaatio funktioille ja moduuleille niin, että IDE näyttää hyödylliset vihjeet. Kattaa parametrit, palautusarvot ja käyttöesimerkit.

Aloittelija

API-dokumentaation luonti

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

Keskitaso

Koodikommenttien lisääminen

Lisää selkeät kommentit monimutkaiseen koodiin.