Bir blogdaki kod örneğini yayımlamadan önce hangi sonucu göstermeli?
Bu konu AI Ürünler Editör tarafından açılan bir uygulama tartışmasıdır. Henüz gerçek kullanıcı denemesi veya topluluk sonucu olarak sunulmaz.
Birlikte inceleyelim
Kopyalanabilir bir kod kutusu yararlıdır; fakat okuyucu hangi dosyayı hazırlayacağını, komutu nerede çalıştıracağını ve hangi çıktıyı bekleyeceğini bilmiyorsa örnek eksik kalır. Bu başlıkta küçük bir Python betiğinin anlatımını gözden geçirelim. Örneğimiz bir klasördeki Markdown dosyalarında boş başlıkları bulsun; amaç hem kodu hem kullanım açıklamasını anlaşılır kılmaktır.
Önce iki küçük örnek dosya hazırlayın: biri geçerli, diğeri bilinçli olarak sorunlu. Kodun başarılı çalışması kadar sorunlu girdiyi nasıl bildirdiği de önemlidir. Çıktıda dosya adının ve ilgili satırın bulunması, okuyucunun düzeltmeye gidebilmesini sağlar. Betiğin değiştirme mi yalnızca kontrol mü yaptığını baştan açıklamak da gereksiz kaygıyı ve yanlış beklentiyi azaltır.
Temsili çalışma kartı
Gereksinim: Python 3
Girdi: ornekler klasöründeki iki Markdown dosyası
İşlem: yalnızca oku ve başlıkları denetle
Beklenen: sorunlu dosya için satır numaralı uyarı
Sınır: dilbilgisi veya doğruluk değerlendirmesi yapmazTartışma soruları
- Okuyucu bağımlılıkları ve çalıştırma komutunu görebiliyor mu?
- Boş veya bozuk dosyada ne oluyor?
- Çıktı bir sorunu düzeltmeye yetecek konum bilgisi içeriyor mu?
- Kodun yapmadığı işi kısa ve somut biçimde açıklıyor musunuz?
Örnek paylaşırken
Yanıta yalnızca kod bırakmak yerine bir örnek girdi ve beklenen çıktı ekleyin. Gerçek müşteri dosyalarını kullanmayın. Çalıştırmadığınız bir örneği test edilmiş diye sunmadan, hangi kısmı gözden geçirdiğinizi açıkça yazın.
Kendi yanıtınızı “hedefim, denediğim adım, gözlemlediğim sonuç ve değiştireceğim tek şey” sırasıyla yazabilirsiniz. Başkasının önerisini denerken önce beklediğiniz sonucu not edin; ardından gerçekte ne gördüğünüzü anlatın. Aynı sorunu farklı yöntemle çözenlerin yaklaşımını da merak ediyoruz. Henüz denemediyseniz bunu belirtip taslak fikrinizi paylaşmanız yeterli.
İlgili ayrıntılı rehber
Adım adım anlatım, görsel akış ve örnekleri açın. Rehberin kaynak bölümündeki resmî belgelere dönerek kullanılan terimleri karşılaştırabilirsiniz.
