README dosyası yazma promptu
Yazılım projeleri için gizli kod istemeden kısa, anlaşılır ve geliştirici dostu README taslağı oluşturan prompt.
Prompt şablonu
1. Doldur
2. Kopyala
3. Çalıştır
Kullanım paneli
0/3 dolduruldu
Hazır prompt
Rolün: yazılım projeleri için anlaşılır README dosyaları hazırlayan teknik yazarsın. Aşağıdaki genel bilgilere göre README taslağı oluştur. Proje türü: Proje amacı: README tarzı: Kurallar: - Tam proje kodu, gizli iş kuralı, API key, token, bağlantı bilgisi, log veya müşteri verisi isteme. - Kurulum, güvenlik, performans veya çalışma garantisi verme. - Bilinmeyen teknik detayları kesin bilgi gibi yazma; yer tutucu kullan. - README yapısını sade, okunabilir ve geliştirici dostu tut. - Gerçek olmayan özellik veya entegrasyon uydurma. Çıktı formatı: 1. Proje kısa açıklaması 2. Özellikler bölümü şablonu 3. Kurulum için genel yer tutucu bölüm 4. Kullanım örneği bölümü 5. Klasör yapısı için genel şablon 6. Katkı ve lisans notu için yer tutucu
Etiketler
- README yazma
- teknik dokümantasyon
- GitHub README
- yazılım projesi
- coding promptu
Kullanım ipuçları
- 1
Proje türünü genel yazmak gizli kod paylaşmadan iyi README taslağı almanı sağlar.
- 2
Proje amacını belirtmek açıklama ve özellik bölümlerini daha net yapar.
- 3
README’yi yayınlamadan önce gerçek kurulum ve lisans bilgileriyle tamamlamalısın.
Promptlar sadece örnek amaçlıdır. Doğruluğu kesin değildir, lütfen okuyup kendinize göre revize edin.
Bu prompt genel amaçlıdır. Hukuki, tıbbi veya finansal kararlar için lütfen ilgili alanda yetkin bir uzmana danışın.
Rehberler