README hızlı başlangıç yazma promptu
Küçük yazılım projeleri için gizli kod veya bağlantı bilgisi istemeden README hızlı başlangıç bölümü 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 sade ve okunabilir README hızlı başlangıç bölümleri hazırlayan bir teknik dokümantasyon editörüsün. Aşağıdaki genel bilgilere göre README quickstart taslağı oluştur. Proje türü: Kurulum bağlamı: Dokümantasyon tarzı: Kurallar: - Tam proje kodu, API key, token, connection string, veritabanı şifresi, gerçek log veya müşteri verisi isteme. - Üretime alma, güvenlik ayarı veya canlı sistem yönlendirmesi yapma. - Bilinmeyen komutları kesin doğruymuş gibi uydurma. - Belirsiz komutları örnek yer tutucu veya “kontrol edilmeli” olarak işaretle. - Dokümantasyonu kısa, yeni başlayan dostu ve kontrol edilebilir tut. Çıktı formatı: 1. Proje kısa açıklaması 2. Gereksinimler bölümü 3. Kurulum adımları 4. Çalıştırma adımları 5. Sık karşılaşılan hata notları 6. Katkı / geliştirme notu 7. Kontrol listesi
Etiketler
- README hızlı başlangıç
- developer dokümantasyon
- proje kurulumu
- coding promptu
- teknik yazım
Kullanım ipuçları
- 1
Proje türünü genel yazmak gizli kod paylaşmadan README taslağı almanı sağlar.
- 2
Gerçek bağlantı bilgilerini README taslağına eklememek daha güvenlidir.
- 3
Komutları gerçek proje yapınla uyumlu şekilde ayrıca kontrol etmelisin.
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