Aloittelija📝 Dokumentointi

Ympäristömuuttujien dokumentaatio

Dokumentoi projektin ympäristömuuttujat.

Prompti

Dokumentoi projektin ympäristömuuttujat.

Muuttujat:
[MUUTTUJAT]

Luo:
1. .env.example tiedosto
2. README-osio ympäristömuuttujille
3. TypeScript-tyypit (jos käytössä)
4. Validointi (esim. zod)

Sisällytä:
- Muuttujan nimi ja kuvaus
- Onko pakollinen
- Oletusarvo (jos on)
- Mistä saa arvon

Suomenkieliset vinkit

  • Suomenkielinen dokumentaatio on arvokasta suomalaisille tiimeille
  • Teknisten termien suomennokset auttavat ymmärtämään konsepteja paremmin

Muuttujat

Korvaa nämä hakasulkeissa olevat muuttujat omilla tiedoillasi:

  • [MUUTTUJAT]

Esimerkki

Täytetty prompti

Dokumentoi projektin ympäristömuuttujat.

Muuttujat:
- DATABASE_URL - Supabase connection string
- NEXT_PUBLIC_SUPABASE_URL - Supabasen julkinen URL
- NEXT_PUBLIC_SUPABASE_ANON_KEY - Supabasen anon key
- STRIPE_SECRET_KEY - Stripen salainen avain
- STRIPE_WEBHOOK_SECRET - Webhook-salaisuus
- RESEND_API_KEY - Sähköpostipalvelun avain

Luo .env.example, README-osio, TypeScript-tyypit ja validointi.

Tulos

Täydellinen env-dokumentaatio.

Vinkit

  • Listaa kaikki muuttujat
  • Merkitse pakolliset selvästi
  • Kerro mistä arvot saa

Milloin käyttää

  • Uusi kehittäjä liittyy tiimiin
  • Dokumentoit projektin setupia
  • Parannat developer experienceä

Liittyvät promptit

README-tiedoston luonti

Luo kattava README-tiedosto projektille.

Aloittelija

Konfiguraatiotiedoston luonti

Luo tai päivitä projektin konfiguraatiotiedostoja.

Keskitaso

JSDoc-kommenttien lisääminen

Lisää JSDoc-dokumentaatio koodille.

Aloittelija

Hyödyllisiä resursseja

Cursor-oppaat

Opi käyttämään prompteja Cursorissa tehokkaasti.

→

Projekti-ideat

Käytä prompteja omissa projekteissasi.

→

Sanasto

Opi vibekoodauksen terminologia.

→

Lisää prompteja

Selaa kaikkia dokumentointi prompteja tai tutustu muihin kategorioihin.

Kaikki dokumentointi promptitKaikki kategoriat