Changeloop blogu

Pratikte release notları

Çok düşündüğümüz iki konu var: birinin okuyacağı release notları nasıl yazılır ve changelog'u elle tutmayı nasıl bırakırsın. Bülten yok, kayıt yok. Sadece yazılar.

  • Alfa ve beta testi: farkları ve ne zaman yapılır

    Alfa ve beta testi karşılaştırması: kim test eder, build ne kadar bitmiştir, kapalı ve açık beta, çıkış kriterleri ve beta geri bildirimi yönetimi.

    Geri bildirim döngüsü6 dk okuma

  • Hotfix nedir? Anlamı, patch farkı ve nasıl yayınlanır

    Hotfix, normal release döngüsünün dışında yayınlanan acil bir düzeltmedir. Terimin anlamı, patch ve bugfix'ten farkı ve güvenle nasıl yayınlanacağı.

    Mühendislik5 dk okuma

  • Kano modeli: talepleri müşterinin hissine göre sıralayın

    Kano modeli, iki soruluk bir anketle özellikleri temel, performans ve heyecan verici gruplarına ayırır. Özellik taleplerinde nasıl uygulanır, nasıl okunur.

    Geri bildirim döngüsü5 dk okuma

  • Release candidate (RC): ne demek ve nasıl yönetilir

    Release candidate, test bir engel bulmazsa nihai sürüm olarak çıkan build'dir. Beta sonrasındaki yeri, sürüm numarası ve çıkış kuralları anlatılıyor.

    Mühendislik4 dk okuma

  • RICE puanlama: formül, çalışılmış örnek ve tuzaklar

    RICE puanlama fikirleri kapsam, etki, güven ve çabaya göre sıralar. Formül, dört özellikli çalışılmış bir örnek, ölçek değerleri ve puanı bozan hatalar.

    Geri bildirim döngüsü4 dk okuma

  • CHANGELOG.md: içine ne girer ve nasıl güncel tutulur

    CHANGELOG.md, her versiyonda neyin değiştiğinin okuyucuya dönük kaydıdır. Gereken bölümler, tam bir örnek ve onu güncel tutan tek alışkanlık burada.

    Mühendislik4 dk okuma

  • GitHub release notes: üretin, sonra okunur hale getirin

    GitHub, merge edilen pull request'lerden release notes taslağını tek tıkla çıkarır. Taslakta ne var, release.yml onu nasıl şekillendirir, nasıl düzenlenir.

    Mühendislik5 dk okuma

  • Müşteri geri bildiriminden ürün roadmap'i nasıl oluşturulur

    Ürün roadmap'i nasıl oluşturulur: mevcut taleplerden başlayan altı adım. Gruplayın, sıralayın, güveni etiketleyin ve düzenli gözden geçirin.

    Geri bildirim döngüsü4 dk okuma

  • Ürün roadmap şablonu: kopyalayıp doldurulacak alanlar

    Ürün roadmap şablonu, her madde için sabit alanları olan bir tablodur. Altı alanlı sürümü kopyalayın, dolu halini görün ve atılacak alanları öğrenin.

    Geri bildirim döngüsü4 dk okuma

  • REST API versiyonlama: URL, başlık ya da sorgu, hangisi uyar

    REST API versiyonlama, versiyonu yola, bir başlığa ya da sorgu dizesine koyar. Her birinin çağıranlar, önbellekler ve duyurular için anlamı, örneklerle.

    API değişiklikleri5 dk okuma

  • Yazılım release notes: nedir ve neleri içermelidir

    Yazılım release notes, okuyucuya bir sürümde neyin değiştiğini, kimi etkilediğini ve ne yapması gerektiğini söyler. Dört tür, içerik ve çalışılmış örnek.

    Pratikte release notları4 dk okuma

  • Hata düzeltmesi release notes: işe yarayan girdiler yazmak

    Hata düzeltmesi release notes, girdi belirtiyi ve sonraki adımı söylediğinde işe yarar. Önce/sonra örnekleri, güvenlik ve veri kaybı kuralları.

    Pratikte release notları6 dk okuma

  • Yazılım ürününde müşteriden geri bildirim nasıl istenir

    Kullanıcı bir şey yaptıktan hemen sonra, çalıştığı yerde tek ve somut bir soru sorun. Her an için hazır cümleler ve kaçınılacak kötü sorular burada.

    Geri bildirim döngüsü6 dk okuma

  • Ürün roadmap örnekleri: altı format ve nasıl bozulurlar

    Gerçekçi maddelerle altı ürün roadmap örneği: Now/Next/Later, çeyreklik, tema, sonuç, genel ve release roadmap. Her biri kime uyar, nasıl bozulur.

    Geri bildirim döngüsü6 dk okuma

  • Sık yayımlayan ekipler için release yönetimi süreci

    Yazılım ekipleri için yedi adımda release yönetimi süreci: her adımın sahibi ve çıkış ölçütü, DORA metrikleri ve ayrıca izlemeye değer bir KPI daha.

    Mühendislik6 dk okuma

  • Her değişiklik türü için release notes örnekleri

    Özellik, düzeltme, breaking change, güvenlik, deprecation, mağaza notu ve dahili not için release notes örnekleri ve her birinin neden işe yaradığı.

    Pratikte release notları6 dk okuma

  • Stripe API versiyonlama: nasıl çalışır, neler kopyalanır

    Stripe API versiyonlama hesabı tarihli bir sürüme sabitler, her istek bunu ezebilir. Nasıl çalıştığı, maliyeti ve küçük bir API'nin kopyalayabilecekleri.

    API değişiklikleri6 dk okuma

  • Changelog'u kim yazar, kim yazmalı

    Changelog'u kim yazar? PR yazarı neyin değiştiğini, PM neden önemli olduğunu bilir. İkisi de tek başına iyi kayıt yazamaz, varsayılan seçim onu eskitir.

    Mühendislik4 dk okuma

  • Acil durum release notes: zaman baskısı altında yazmak

    Bir olay kaynaklı sürüm, günler değil dakikalar içinde yazılmış notlara ihtiyaç duyar, ve olağan yazım süreci sahip olmadığınız zamanı varsayar.

    Pratikte release notları4 dk okuma

  • Protobuf breaking change'leri: wire'da neler hayatta kalır

    Protobuf breaking change'leri URL'de değil, wire'da olur. Bazı alan değişiklikleri ücretsizdir, diğerleri her client'ı sessizce bozar, diff'te aynıdır.

    API değişiklikleri5 dk okuma

  • Changelog dosya formatları: JSON, YAML veya sadece Markdown

    Bir changelog dosyasının formatı, bir sayfayı besleyip besleyemeyeceğini belirler, yoksa sadece insan okur. Markdown, JSON ve YAML farklı bedeller öder.

    Mühendislik5 dk okuma

  • Yinelenen özellik talepleri: sesi kaybetmeden birleştirmek

    Yinelenen özellik taleplerini gruplamak sayımı korur. Onları dikkatsizce birleştirmek birini yararlı kılan ifadeyi kaybeder, ve bu daha küçük kayıptır.

    Geri bildirim döngüsü5 dk okuma

  • Versiyon numarası olmadan GraphQL deprecation

    GraphQL'de URL'de v1 veya v2 yok. Alanlar paylaşılan tek şema üzerinde, bir direktifle tek tek deprecate edilir ve bu changelog'un borcunu değiştirir.

    API değişiklikleri5 dk okuma

  • API geçiş kılavuzu nasıl yazılır

    API geçiş kılavuzu, uyumsuz bir değişikliği kesintiye değil kontrol listesine dönüştürür. Neye ihtiyacı var, ve neden tek başına bir giriş yetmez.

    API değişiklikleri4 dk okuma

  • GitHub Actions'ta changelog kaydı zorunlu kılın: workflow

    GitHub Actions'ta bir changelog kontrolü kayıtsız merge'ü reddeder, çünkü hatırlamaya bağlı adım öngörülebilir biçimde çöker. Ve bu kontrolün bozduğu şey.

    Mühendislik4 dk okuma

  • Müşteriyi kaybetmeden bir özellik talebi nasıl reddedilir

    Döngüyü kapatmak genelde birine talebinin gönderildiğini söylemektir. Zor yarısı müşteriyle ilişkiyi bozmadan hayır demektir. Bunu nasıl yapacağınız.

    Geri bildirim döngüsü4 dk okuma

  • Feature flag release notları: ne söylenir, ne zaman

    Feature flag release notları merge ile yayını ayırmalıdır; bir flag varken ikisi aynı an değildir. Döngüyü erken kapatmak görünmeyen bir özelliği duyurur.

    Geri bildirim döngüsü5 dk okuma

  • Özellik taleplerini kaybetmeden takip etmek

    Özellik talebi takibi genelde iki şekilde başarısız olur: talepler hiçbir yere gitmez ya da kimsenin bakmadığı yere gider. Her ikisine dayanan bir sistem.

    Geri bildirim döngüsü5 dk okuma

  • Özellik talebi mi hata raporu mu: nasıl ayırt edilir

    Yeni bir ayar isteyen bir destek bileti, gizli bir hata için bir workaround olabilir. Yanlış etiket onu yanlış sahibe ve yanlış kuyruğa gönderir.

    Geri bildirim döngüsü4 dk okuma

  • Destek biletleri vs. özellik talepleri: hangisi?

    Bir destek bileti ve bir özellik talebi panosu farklı şeyleri ölçer, ve birindeki artışı diğerindekiyle eşdeğer saymak yanlış önceliklere yol açar.

    Geri bildirim döngüsü4 dk okuma

  • Git tag, GitHub release ve changelog: aralarındaki fark

    Bir git etiketi, bir sürüm ve bir changelog girişi aynı olayın üç kaydıdır. Bunları karıştırmak changelog'un kaymasına yol açar. Üçü nasıl uyuşmalı.

    Mühendislik5 dk okuma

  • Dahili release notları: kimin bilmesi gerekir

    Destek ve satış bir lansmanı genelde kafası karışmış bir müşteriden öğrenir. Dahili release notları bunu müşteri notlarından farklı bir biçimde çözer.

    Pratikte release notları4 dk okuma

  • Dahili API changelog'ları: diğer ekip için ne değişir

    Genel bir API changelog'unun doğrudan ulaşamayacağınız bir kitlesi vardır. Dahili olanın kitlesi iki kat öteden gelir ve ona borcunuzu değiştirir.

    API değişiklikleri5 dk okuma

  • Mobil release notes: App Store ve Google Play sınırları

    App Store notlarına 4.000, Google Play'e 500 karakter sığar; ikisi de birkaç satır gösterir, link vermez. Sınır neyi keser, nasıl bilinçli kesilir.

    Pratikte release notları4 dk okuma

  • Monorepo changelog'ları: tek mi, paket başına mı?

    Bir monorepo tüm repo için tek changelog tutabilir veya paket başına bir tane, ve yanlış seçim her release'i ya çok gürültülü ya da çok dağınık yapar.

    Mühendislik5 dk okuma

  • Yeni özellik duyurusu: şablonlar ve nasıl yazılır

    Çoğu özellik duyurusu, kimsenin iki kez okumadığı bir kanalda ölür. Nerede duyurulur, önce ne söylenir, ve gerçekten isteyen kişilere nasıl ulaşılır.

    Pratikte release notları5 dk okuma

  • Birikmiş özellik taleplerine öncelik vermek

    Takip edilen bir birikim zor soruyu açık bırakır: sırada hangi talep var. İşe yarayan çerçeveler, her birinin kırıldığı yer ve oy sayısının gizlediği şey.

    Geri bildirim döngüsü5 dk okuma

  • Kurumsal release notları: bir hesap için ne değişir

    Özel build kullanan müşteri için kurumsal release notları onun örneğine göre ayarlanmalı. Yanlış ayar roadmap'i sızdırır ya da destek ekibini karıştırır.

    Pratikte release notları4 dk okuma

  • Semantic versioning ve changelog: her sıçrama ne demek

    Semantic versioning, bir sürümün changelog'da tek kelime okumadan önce ne kadar canını yakabileceğini söyler. Her sayının vaadi, bir girişin borcu.

    Mühendislik5 dk okuma

  • API sunset header'ı: ne zaman gönderilir

    API sunset header'ı, deprecation'ın aksine, bir sürümün ne zaman yanıt vermeyi durduracağını söyler. RFC 8594 neyi kapsar, brownout ne kazandırır.

    API değişiklikleri4 dk okuma

  • Webhook changelog'ları: kimsenin istemediği breaking change

    Bir webhook payload değişikliği sessizce bozulur, çünkü onu reddedecek bir çağıran yoktur. Neyin breaking sayıldığı ve payload'ın nasıl versiyonlanacağı.

    API değişiklikleri4 dk okuma

  • Changelog nedir? Tanım ve örnek bir kayıt

    Changelog, bir üründe neyin değiştiğini tarihiyle kaydeden, kullanıcıları için yazılmış listedir. Tanım, örnek bir kayıt ve kopyalayacağınız şablon.

    Pratikte release notları5 dk okuma

  • API changelog: neyi yayınlamalı, kim okur

    Bir API changelog'unu, kodunun gelecek ay hala çalışıp çalışmayacağına karar veren kişiler okur. Her kaydın onlara borcu, yeri ve abonelik yolu.

    API değişiklikleri6 dk okuma

  • Herkese açık changelog sayfası: takip edilen bir sayfa

    Bir changelog sayfası, biri ona geri döndüğünde değerlidir. Nerede yaşamalı, her kayıt neye ihtiyaç duyar, akışlar ve markup, ve widget nereye oturur.

    Mühendislik5 dk okuma

  • Okunan ürün güncellemesi e-posta şablonu

    Okunan ürün güncellemesi e-postası, onu talep eden birine gitti. Bir şablon, dört e-posta türü, işe yarayan konu satırları, segmentasyon ve onay.

    Pratikte release notları5 dk okuma

  • API deprecation: takvim, bildirim ve RFC 9745 başlıkları

    Deprecation, üzerinde tarih olan bir sözdür. Zaman çizelgesi, bildirim şablonu, yanıt başlıkları, ve bir sunset'in olaya dönüşmesini durduran adım.

    API değişiklikleri5 dk okuma

  • Çağıranlar için API versiyonlama en iyi uygulamaları

    Sadece bozan şeyi versiyonlayın, versiyonu çağıranların görebileceği yere koyun, ve eskisini bir tarihe kadar çalışır tutun. Dört şema karşılaştırıldı.

    API değişiklikleri6 dk okuma

  • Breaking change nedir? Ne sayılır ve nasıl gönderilir

    Breaking change, doğru bir çağıranın hayatta kalamayacağı değişikliktir. Ne sayılır, ne sayılmaz, CI'da nasıl yakalanır ve güvenle nasıl gönderilir.

    API değişiklikleri8 dk okuma

  • Geri bildirim döngüsünü changelog tarafından kapatmak

    Bir geri bildirim döngüsü, isteyen kişi gönderildiğini bildiğinde kapanır. Dört adımda döngü, nerede bozulduğu, ve changelog'un neden doğru yer olduğu.

    Geri bildirim döngüsü6 dk okuma

  • Changelog'a dönüşen feature-request-şablonu

    Bir özellik isteği, ancak gönderildiğinde bulunabilirse işe yarar. Şablon, onu yönlendiren etiketler, ve changelog'un sonra okuduğu alanlar burada.

    Geri bildirim döngüsü5 dk okuma

  • Issue tracker'ınızdan genel roadmap, üç sütun

    Genel bir roadmap gelecek hakkında bir sözdür. Küçük tutun, zaten takip ettiğiniz issue'lardan besleyin ve her öğeyi issue'sundaki bir etiketle taşıyın.

    Geri bildirim döngüsü5 dk okuma

  • Changelog otomasyonu: neyi otomatikleştirmeli, neyi değil

    Toplama, biçimlendirme ve yayımlamayı otomatikleştirin. Seçimi ya da ifadeyi otomatikleştirmeyin. Çizginin nerede olduğu ve kaydığında ne olduğu.

    Mühendislik5 dk okuma

  • Changelog vs release notes: fark nedir?

    Bir changelog bir şey arayanlar için sürekli bir kayıttır. Release notes ilgilenip ilgilenmeyeceğine karar verenler için özenle seçilmiş bir mesajdır.

    Pratikte release notları5 dk okuma

  • Conventional commits'ten bir changelog'a

    Conventional commits bir changelog'u türetilebilir yapar. Okunabilir yapmaz. Konvansiyonun sağladığı, durduğu yer, ve boşluğu nasıl kapatacağınız.

    Mühendislik5 dk okuma

  • İnsanların gerçekten okuduğu release notes nasıl yazılır

    «Hata düzeltmeleri ve performans iyileştirmeleri» bir release note değildir. Her girdinin cevaplaması gereken soru ve gerçek birinin yeniden yazımı.

    Pratikte release notları6 dk okuma

  • Keep a Changelog açıklaması: CHANGELOG.md şablonuyla

    Spesifikasyon bir sayfadır ve okunması on dakika sürer. Ekiplerin saptığı yer uygulama aşamasıdır. Ne dediği, ne bıraktığı, ve nerede yanlış gittiği.

    Mühendislik5 dk okuma

  • Değer verilen release notes en iyi uygulamaları

    Çoğu en iyi uygulama listesi stil tavsiyesidir. Bunlar okuyucunun ne yaptığını gerçekten değiştirir, ayrıca kargo kültü olan üç popüler öneri de var.

    Pratikte release notları5 dk okuma