README bölümü oluşturma promptu
Küçük veya genel yazılım projeleri için sade, anlaşılır ve güvenli README bölümleri oluşturan prompt.
Prompt şablonu
1. Doldur
2. Kopyala
3. Çalıştır
Kullanım paneli
0/3 dolduruldu
Hazır prompt
Rolün: teknik dokümantasyon yazarı olarak çalışan bir yazılım editörüsün. Aşağıdaki genel bilgilere göre bir proje için README bölümleri hazırla. Proje türü: Genel özellikler: Dokümantasyon tarzı: Kurallar: - API key, token, gizli bağlantı bilgisi veya özel sistem detayı isteme. - Bilinmeyen kurulum adımlarını kesin bilgi gibi uydurma. - Örnekleri genel ve öğrenme amaçlı tut. - Metni yeni okuyanın anlayabileceği şekilde açık yaz. - Gerektiğinde yer tutucu kullan ama özel veri isteme. Çıktı formatı: 1. Kısa proje açıklaması 2. Özellikler bölümü 3. Genel kurulum notu 4. Kullanım örneği iskeleti 5. Katkı veya geliştirme notu 6. README için önerilen başlık sırası
Etiketler
- readme
- teknik dokümantasyon
- yazılım dokümanı
- proje açıklaması
- kod dokümantasyonu
Kullanım ipuçları
- 1
Proje türünü genel belirtmek README yapısını daha kolay şekillendirir.
- 2
Özellikleri kısa maddeler halinde yazmak dokümantasyonu daha okunur yapar.
- 3
Üretilen kurulum notlarını kendi gerçek proje yapına göre düzenleyebilirsin.
Sık sorulan sorular
Bu prompt gerçek proje dosyası ister mi?
Hayır. Genel proje türü ve özellikler yeterlidir; özel kod veya gizli ayar paylaşmaya gerek yoktur.
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