README dosyası taslağı oluşturma promptu
Proje adı, türü, amacı, teknoloji stack'i ve ana özelliklere göre GitHub uyumlu, düzenlenebilir ve güvenli README dosyası taslağı oluşturan yazılım dokümantasyonu promptu.
Prompt şablonu
Proje adı, türü, amacı, teknoloji stack'i ve ana özelliklere göre GitHub uyumlu, düzenlenebilir ve güvenli README dosyası taslağı oluşturan yazılım dokümantasyonu promptu.
Kullanım paneli
0/9 dolduruldu
Rolün: Yazılım projeleri için açık, düzenli ve GitHub uyumlu README dosyası taslakları hazırlayan bir teknik dokümantasyon asistanısın. Aşağıdaki bilgilere göre projenin amacını, teknolojilerini, özelliklerini ve kullanım notlarını anlaşılır şekilde anlatan bir README taslağı oluştur. Proje adı: Proje türü: Projenin amacı: Teknoloji stack'i: Ana özellikler: Kurulum bağlamı: README tarzı: Çıktı dili: Ek notlar: Kurallar: - Genel, güvenli ve yazılım dokümantasyonu bağlamıyla çalış. - Kullanıcının vermediği özellik, entegrasyon, lisans, deployment, canlı URL, test sonucu veya performans iddiası ekleme. - Özel repo bağlantısı, API anahtarı, secret, token, bağlantı bilgisi, müşteri verisi veya şirket içi detay isteme. - Kurulum ve çalıştırma adımlarını kullanıcı tarafından kontrol edilebilir taslak olarak hazırla. - Belirsiz komutları, ortam değişkenlerini veya sürüm bilgilerini kesin bilgi gibi yazmak yerine kontrol edilmesi gereken notlara ayır. - README metnini doğrudan nihai belge gibi değil, kullanıcının proje yapısına göre düzenleyebileceği markdown taslağı olarak sun. - Açıklamaları sade, düzenli ve yeni kullanıcıların projeyi anlamasını kolaylaştıracak şekilde hazırla. Çıktı formatı: 1. README başlığı 2. Kısa proje açıklaması 3. Projenin amacı 4. Ana özellikler 5. Kullanılan teknolojiler 6. Önerilen klasör yapısı açıklaması 7. Kurulum taslağı 8. Kullanım taslağı 9. Ortam değişkenleri için güvenli not alanı 10. Ekran görüntüsü / demo alanı 11. Katkı sağlama bölümü 12. Lisans bölümü 13. Kontrol edilmesi gereken bilgiler 14. Tam markdown README taslağı
Bu bölüm, promptu ne zaman ve nasıl kullanabileceğini daha net anlamana yardımcı olur.
Bu prompt, yazılım projeleri için GitHub uyumlu README dosyası taslağı oluşturmak amacıyla kullanılır. Proje adı, amacı, teknoloji stack'i ve ana özelliklere göre açıklama, kurulum, kullanım, katkı, lisans ve kontrol notları içeren düzenlenebilir markdown taslağı hazırlar.
Yazılım geliştiriciler, öğrenciler, açık kaynak proje sahipleri, GitHub reposu hazırlayanlar, portfolyo projesi yayınlayanlar ve proje dokümantasyonunu daha düzenli hale getirmek isteyen kullanıcılar için uygundur.
Yeni bir proje yayınlamadan önce README hazırlamak, mevcut projenin açıklamasını düzenlemek, GitHub reposunu daha anlaşılır hale getirmek veya kurulum ve kullanım notlarını yapılandırmak istediğinizde kullanılabilir.
Bir kullanıcı Expo React Native ile geliştirdiği İngilizce kelime öğrenme uygulaması için GitHub README hazırlamak isteyebilir. Bu prompta proje adı, amacı, teknoloji stack'i ve ana özellikler girilerek düzenli bir markdown README taslağı alınabilir.
Proje amacı, ana özellikler ve teknoloji stack'i ne kadar net yazılırsa README o kadar kullanışlı olur. Kurulum komutları ve ortam değişkenleri kesin değilse bunları kontrol edilmesi gereken alanlar olarak bırakmak daha güvenli sonuç verir.
Bu prompt README dosyasını doğrudan yayınlamak için mi hazırlar?
Hayır. Kullanıcının kendi proje yapısına göre kontrol edip düzenleyebileceği markdown README taslağı oluşturur.
Bu prompt gizli API anahtarı veya ortam değişkeni ister mi?
Hayır. Gizli bilgi istemez; ortam değişkenleri için güvenli ve boş bir açıklama alanı oluşturabilir.
Bu örnek, promptun bir yazılım projesi için nasıl GitHub uyumlu README taslağı oluşturabileceğini göstermek için hazırlanmıştır.
LingoGlow, İngilizce kelime öğrenimini daha düzenli ve motive edici hale getirmek için tasarlanmış bir mobil uygulama projesidir. Uygulama; seviye bazlı kelime listeleri, çoktan seçmeli pratikler ve ilerleme takibiyle öğrenme sürecini destekler.
- Seviye bazlı İngilizce kelime listeleri - Çoktan seçmeli kelime pratiği - İlerleme takibi - Sade ve mobil uyumlu arayüz - Local storage ile cihaz içi veri saklama
- Expo React Native - TypeScript - Local storage - Mobil odaklı UI bileşenleri
- Gerçek klasör yapısı - Kurulum komutları - Paket yöneticisi tercihi - Lisans türü - Test komutları - Ekran görüntüleri veya demo bağlantısı
Bu örnek, README dosyası için hazırlanmış düzenlenebilir markdown taslağıdır. Kullanıcı gerçek klasör yapısını, komutları, lisansı, testleri, ortam değişkenlerini ve deployment bilgilerini kendi projesine göre kontrol etmelidir.
Proje amacını net yazmak README dosyasının daha anlaşılır olmasına yardımcı olur.
Teknoloji stack'ini belirtmek kurulum ve kullanım bölümlerinin daha doğru taslaklanmasını sağlar.
Ana özellikleri madde madde yazmak README'nin hızlı okunabilirliğini artırır.
README taslağını kullanmadan önce komutları, sürümleri, klasör yollarını ve ortam değişkenlerini kendi projenize göre kontrol etmelisiniz.
Hayır. Özel repo, API key, secret, token, bağlantı bilgisi veya şirket içi detay istemeden genel proje bilgileriyle README taslağı oluşturur.
Evet. Markdown formatında GitHub uyumlu README başlıkları, açıklamalar ve bölümler hazırlayabilir.
Kurulum adımlarını taslak olarak yazabilir; ancak komutlar, sürümler ve ortam değişkenleri kullanıcı tarafından proje yapısına göre kontrol edilmelidir.
Evet. Kullanıcı isterse lisans, katkı, demo ve ekran görüntüsü alanları için düzenlenebilir bölümler ekleyebilir.
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.
Markdown dosyaları AI ile çalışırken neden kullanışlı olabilir? Başlık, liste, tablo, kod bloğu, README ve prompt notlarıyla düzenli bilgi hazırlama rehberi.
Devamını okuYazılım projeleri için README dosyasını proje amacı, kurulum, kullanım, klasör yapısı ve kontrol listesiyle düzenli taslağa dönüştürmeyi öğrenin.
Devamını okuAI promptlarını güvenli, aranabilir ve uygulanabilir şekilde yazmak için adım adım iş akışı, değişken tasarımı, çıktı formatı ve kontrol listesi.
Devamını oku# LingoGlow LingoGlow, İngilizce kelime öğrenimini oyunlaştırılmış mini pratiklerle desteklemek için geliştirilen bir mobil uygulama projesidir. ## Özellikler - Seviye bazlı kelime listeleri - Çoktan seçmeli pratik ekranları - İlerleme takibi - Sade ve kullanıcı dostu mobil arayüz - Local storage ile cihaz içi veri saklama ## Kullanılan Teknolojiler - Expo React Native - TypeScript - Local storage ## Kurulum Aşağıdaki adımlar proje yapısına göre kontrol edilmelidir: ```bash npm install npm start ``` ## Kullanım Uygulama lokal geliştirme ortamında çalıştırıldıktan sonra mobil cihaz veya emülatör üzerinden test edilebilir. ## Ortam Değişkenleri Bu bölümde gizli bilgi paylaşılmamalıdır. Gerekli ortam değişkenleri varsa yalnızca örnek anahtar adları ve açıklamaları eklenmelidir. ## Ekran Görüntüleri Bu alana uygulama ekran görüntüleri eklenebilir. ## Katkı Katkı kuralları proje sahibinin tercihine göre düzenlenmelidir. ## Lisans Lisans türü yayın öncesinde kontrol edilmelidir.