Aloittelija📝 Dokumentointi

README-tiedoston luonti

Luo kattava README-tiedosto projektille.

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

Lisää prompteja

Selaa kaikkia dokumentointi prompteja tai tutustu muihin kategorioihin.