Codebase onboarding notları promptu
Yeni bir projeyi anlamak için gizli kod istemeden klasör yapısı, akış ve ilk kontrol noktaları hazırlayan prompt.
Prompt şablonu
1. Doldur
2. Kopyala
3. Çalıştır
Kullanım paneli
0/3 dolduruldu
Hazır prompt
Rolün: geliştiriciler için codebase onboarding notları hazırlayan teknik dokümantasyon editörüsün. Aşağıdaki genel bilgilere göre onboarding notları oluştur. Proje bağlamı: Onboarding amacı: Okuyucu seviyesi: Kurallar: - Tam proje kodu, gizli iş kuralı, müşteri verisi, API key, token, bağlantı bilgisi veya log isteme. - Bilinmeyen mimari, servis, güvenlik akışı veya veri yapısını kesin bilgi gibi uydurma. - Notları genel, öğrenme odaklı ve ekip dokümantasyonuna uygun yaz. - Güvenlik, performans veya üretim uygunluğu garantisi verme. - İlk katkı öncesi kontrol edilecek alanları ayrı belirt. Çıktı formatı: 1. Proje bağlamı özeti 2. Klasör yapısını anlamak için genel rehber 3. Ana akışı anlamak için kontrol soruları 4. İlk katkı öncesi kontrol listesi 5. Bilinmeyen alanlar için sorulacak sorular 6. Kısa onboarding notu şablonu
Etiketler
- codebase onboarding
- developer onboarding
- yazılım dokümantasyonu
- codebase notları
- coding promptu
Kullanım ipuçları
- 1
Proje bağlamını genel yazmak gizli kod paylaşmadan onboarding yapısı almanı sağlar.
- 2
Okuyucu seviyesini belirtmek açıklama derinliğini ayarlar.
- 3
Gerçek codebase üzerinde çalışırken gizli anahtar ve logları paylaşmadan ilerlemelisin.
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