Sürüm Notları Şablonu

Bu sürüm notları şablonu, bir yayın ekibinin kullanıcılara neyin değiştiğini anlatmak için ihtiyaç duyduğu 11 bölümü ortaya koyar. Yapının tamamını kopyalayın, kayıt gerekmez, ya da PDF olarak indirin.

Sürüm Notları Şablonu (Kopyala-Yapıştır Hazır)

Aşağıdaki blok şablonun tamamıdır; kayıt olmadan ya da e-posta adımı gerekmeden anında kopyalanabilir. Word, Google Docs, Confluence, Notion veya bir Markdown dosyasına değişmeden yapıştırılır; yazdırmayı tercih ederseniz PDF de aynı 11 bölümü içerir. Köşeli parantez içindeki alanları değiştirin, ardından bu sürümün dokunmadığı bölümleri silin.

[Ürün Adı] Sürüm Notları
Sürüm: [x.y.z]
Yayın tarihi: [YYYY-AA-GG]
Platform / ortam: [web, iOS, Android, API, staging]

Değişikliklerin özeti (Amaç)
[Bir veya iki cümle: bu sürüm neyi ele alıyor ve kimi etkiliyor]

Yeni özellikler
- [Kullanıcının artık yapabildiği şey, dahili özellik adı değil]

İyileştirmeler ve geliştirmeler (Performans İyileştirmeleri)
- [Zaten var olan şey ve kullanıcı açısından ne daha iyi hale geldi]

Hata düzeltmeleri
- Düzeltildi: [kullanıcının önceden gördüğü şey ve şimdi ne oluyor]

Kırıcı değişiklikler ve geçiş adımları
- [Artık çalışmayan şey], bu yüzden [neyi, ne zamana kadar değiştirmeniz gerekiyor]

Bilinen sorunlar ve geçici çözümler (Devam Eden Sorunlar)
- [Çözülmemiş sorun] · [etkilenen platform] · [geçici çözüm] · [düzeltme zaman çizelgesi]

Yükseltme veya kurulum adımları (Yükseltme Adımları / Kurulum Notları)
1. [Okuyucunun yeni sürüme geçmek için yapması gereken şey]

Kullanımdan kaldırmalar
- [Özellik, entegrasyon veya API] [tarih] itibarıyla kullanımdan kaldırılıyor. [Yerine ne geçecek]

Güvenlik notları
- [Güvenlikle ilgili değişiklik, açığı tarif etmeden belirtilir]

Yardım alma ve geri bildirim verme
- Dokümanlar: [bağlantı] · Destek: [e-posta veya kanal] · Geri bildirim: [bağlantı]

Sürüm Notları Şablonuna Neler Girer

Bir sürüm notları şablonunun her biri tek bir işe yarayan on bir bölümü vardır. Her bölümü onu okuyacak kişi için yazın: geliştiriciler ve müşteriler farklı şeylere ihtiyaç duyar.

Sürüm Notları Şablonu Nasıl Kullanılır

1. Şablonu, sürümünüzün zaten yaşadığı yere kopyalayın. Jira, Confluence, Notion, GitHub veya Azure DevOps'a değişmeden yapıştırılır; böylece not, ayrı bir dokümanda değil, işin yanında durur.
2. Önce üst bilgi satırını doldurun. Ürün adı, sürüm numarası, yayın tarihi ve platform; böylece nota gelen herkes bir kelime bile okumadan hangi derlemeyi anlattığını bilir.
3. Yayın günlüğünü toplayın ve kullanıcının ne gördüğüne göre sıralayın. Her değişikliği yeni özellikler, iyileştirmeler, hata düzeltmeleri ve bir şeyi bozan değişiklikler olarak ayırın, kullanıcıya görünmeyen maddeleri çıkarın.
4. Her maddeyi uygulama ayrıntısı değil, yeteneği anlatacak şekilde yazın. "Toplu işleme uygulandı" ifadesi "Artık işlemin zaman aşımına uğramasına gerek kalmadan büyük veri kümelerini dışa aktarabilirsiniz" olur; bu da okuyucunun bu sürümün onu etkileyip etkilemediği sorusuna yanıt verir.
5. Arayüzün değiştiği her yere bir ekran görüntüsü veya kısa bir GIF ekleyin. Bir madde üç paragraf gerektiriyorsa muhtemelen on beş saniyelik bir GIF'e ihtiyacı vardır.
6. Bu sürümün dokunmadığı bölümleri silin, kalanları sırasında bırakın. Bir yama, yeni özellikler ve yükseltme adımlarını çıkarır; kullanıcıların her sürümde yapıyı yeniden öğrenmesi gerekmemelidir.
7. Taslağı tek bir sorumlu kişiye teslim edin, ardından yayınlayın. Onayı üstlenen tek bir kişi olmadan not ya geç yayınlanır ya da iki kez yayınlanır.

Sürüm Notları Şablonu: Doldurulmuş Bir Örnek

Bu, kurgusal bir sevkiyat ürününün bir özellik sürümü için doldurduğu, aynı şablondur.

• Fieldpost 4.2.0 · Yayın tarihi: 12 Mart 2026 · Platform: Web ve iOS
• Değişikliklerin özeti: Dışa aktarmalar artık büyük hesaplarda tamamlanıyor, Kanada fiyatlandırması doğru ve kendi barındırdıkları sistemi çalıştıran yöneticiler için tek bir geçiş adımı var.
• Yeni özellikler
• Zamanlanmış dışa aktarmalar. Artık bir raporun her Pazartesi çalışıp gelen kutunuza düşmesini ayarlayabilirsiniz.
• Toplu durum güncellemeleri. 500'e kadar işi seçip durumlarını tek bir işlemle değiştirebilirsiniz.
• İyileştirmeler ve geliştirmeler
• Daha hızlı sevkiyat panosu. Pano, 10.000 açık işi olan hesaplarda dokuz saniyeden yaklaşık iki saniyeye inerek yükleniyor.
• Hata düzeltmeleri
• Düzeltildi: 50.000 satırı aşan dışa aktarmalar zaman aşımına uğruyor ve boş dosya döndürüyordu.
• Düzeltildi: fiyatlar Kanadalı hesaplarda USD olarak gösteriliyordu.
• Kırıcı değişiklikler ve geçiş adımları
• 4.2.0 sürümü v1 /exports uç noktasını kaldırıyor. Entegrasyonlarınızı, bir iş kimliği döndüren /v2/exports'a yönlendirin. Kendi barındırdıkları kurulumlar, 4.2.0'ı başlatmadan önce fieldpost migrate --v2-exports komutunu çalıştırır.
• Bilinen sorunlar ve geçici çözümler
• iOS'ta, Pazar için zamanlanan dışa aktarmalar bunun yerine Pazartesi çalışıyor. 4.2.1 sürümü 26 Mart'ta çıkana kadar web uygulamasını kullanın.
• Yükseltme veya kurulum adımları
• Bulut hesapları zaten 4.2.0 sürümünde. iOS kullanıcıları 31 Mart'a kadar App Store üzerinden güncelleme yapar.
• Kullanımdan kaldırmalar
• Fieldpost, yalnızca CSV rapor biçimini 1 Eylül 2026'da kullanımdan kaldırıyor. Kayıtlı raporları XLSX'e geçirin.
• Güvenlik notları
• Oturum jetonları artık 12 saat sonra sona eriyor, yöneticiler başka bir kullanıcının oturumlarını sonlandırabiliyor.
• Yardım alma ve geri bildirim verme
• Dokümanlar: docs.fieldpost.example · Destek: support@fieldpost.example · Geri bildirim: uygulamadaki Geri Bildirim sekmesi.

Sürüm Notları Şablonu Varyantları

Aşağıdaki beş varyant iki eksende durur: notu kim okuyor ve hangi tür sürümü kapsıyor. Her biri üst bilgi satırını ve değişikliklerin özetini korur, ardından diğer dokuz bölümü ekler, çıkarır veya yeniden yazar. İşin can alıcı kısmı bu farklardır; çünkü küçük bir sürüm için neyi sileceğine karar vermek çoğu ekibin yanlış yaptığı şeydir.

Büyük Sürüm Notları Şablonu

Bu varyant 11 bölümün tamamını çalıştırır. Her yeni özellik bir paragraf ile birlikte bir ekran görüntüsü veya GIF alır, geçiş adımlarına bağlantı vermek yerine bunları ayrıntılı olarak yazarsınız ve değişikliklerin özetini tek başına anlaşılır olacak şekilde kaleme alırsınız; çünkü bu, ekip arkadaşlarının Slack'e yapıştırıp size geri alıntıladığı satırdır.

• Korur: 11 bölümün tamamını.
• Genişletir: yeni özellikler, kırıcı değişiklikler ve geçiş adımları, yükseltme adımları.
• Dikkat: özet, başka hiçbir bölüme bağlı olmadan anlamlı olmalıdır.

Yama veya Acil Düzeltme Sürüm Notları Şablonu

İşin çoğunu dört bölüm yapar: üst bilgi satırı, özet, hata düzeltmeleri ve varsa kalan bilinen sorunlar. Önce düzeltmeyle, sonra kimi etkilediğiyle, sonra okuyucunun bir şey yapması gerekip gerekmediğiyle başlayın. Bir sürüm numarasıyla açılıp düzeltmeyi üçüncü paragrafa gömen bir acil düzeltme notu, onu hızlı yayınlamanın amacını boşa çıkarır.

• Çıkarır: yeni özellikler, iyileştirmeler, kullanımdan kaldırmalar, yükseltme adımları.
• Korur: üst bilgi satırı, özet, hata düzeltmeleri, bilinen sorunlar.
• Dikkat: hiçbir işlem gerekmediğinde bunu açıkça belirtin.

Dahili veya Teknik Sürüm Notları Şablonu

Bunu, sistemi işleten ekip için yazarsınız; bu yüzden fayda odaklı anlatım gider, mekanik ayrıntılar gelir. Etkilenen servisleri, değişen yapılandırmayı ve bir ekip arkadaşının sabahın ikisinde karşılaşacağı her şeyi belirtin.

• Ekler: kod değişiklikleri, API ve veritabanı değişiklikleri, ortam ve yapılandırma notları.
• Çıkarır: kullanıcıya yönelik fayda odaklı anlatım.
• Korur: kırıcı değişiklikler, bilinen sorunlar, yükseltme adımları; bunlar bu varyantta diğerlerine göre daha fazla ağırlık taşır.

Mobil Uygulama Mağazası Sürüm Notları Şablonu

Mağaza listelemeleri karakter sayısını sınırlar, bu yüzden notun tamamı bir sürüm satırına ve kısa bir "yenilikler" listesine sıkışır. Her biri kullanıcının artık yapabildiği bir şeyi adlandıran, en önemli olana göre sıralanmış üç ila beş madde yazın.

• Korur: üst bilgi satırı, sıkıştırılmış yeni özellikler listesi, dikkate değer düzeltmeler için tek satır.
• Çıkarır: bilinen sorunlar, kullanımdan kaldırmalar, güvenlik notları, geçiş adımları.
• Dikkat: mağaza listelemesinden çıkarılan her şey, kendi barındırdığınız tam notta yine de yer almalıdır.

API Sürüm Notları Şablonu

Bunu son kullanıcı için değil, size karşı entegrasyon yapan bir geliştirici için yazarsınız. Her madde dokunduğu uç noktayı veya parametreyi adlandırır ve her kullanımdan kaldırma, okuyucunun takvimine yazabileceği bir sona erme tarihi taşır.

• Ekler: uç nokta değişiklikleri, parametre değişiklikleri, istek ve yanıt içeren bir geçiş örneği.
• Genişletir: sona erme tarihleriyle birlikte kullanımdan kaldırmalar ve kırıcı değişiklikler.
• Çıkarır: bir geliştiricinin ihtiyaç duymadığı ekran görüntüleri ve GIF'ler.

Bir güvenlik yaması, sürüme uyan varyantı kullanır; buna eklenen tek kural şudur: güvenlik notunu olgusal tutun ve açığın kendisini tarif etmeyin.

Sürüm Notları Şablonu Ne Zaman Kullanılır

Kullanıcının görebildiği veya tepki vermesi gereken her sürümde şablona başvurun. En sık görülen üç tetikleyici bir özellik lansmanı, bir hata düzeltmesi veya acil düzeltme ve dahili bir derlemedir. Güvenlik yamaları, API sürümleri ve mağaza güncellemeleri, farklı bölümlerin devreye girdiği aynı yapıyı kullanır.

Sürüm notları, bir değişiklik günlüğü ve yama notları farklı sorulara yanıt verir. Sürüm notları sürüm başınadır ve değişikliğin etkilediği kitle için okunabilir biçimde yazılır. Değişiklik günlüğü ise geliştiriciye yönelik, kalıcı ve tam kronolojik kayıttır. Yama notları, yalnızca düzeltme içeren bir sürüm için kısa sürüm notudur. Ekip dışından biri tepki vermek zorunda kaldığında sürüm notlarını yayınlayın ve değişiklik günlüğünü arka planda sürekli işler halde tutun.

Sahiplik bir devir teslim olarak işler. Mühendislik ekibi yayın günlüklerini sağlar, bir PM veya PMM bunları kullanıcıya yönelik maddelere çevirir ve not yayınlanmadan önce tek bir isim onay verir.

Boş Dokümanı Atlayın: Bunun Yerine Kaydedin

Boş bir şablonu doldurmak, çoğu ekibin sürüm zaten yayınlanana kadar ertelediği adımdır. Diğer yol, zaten vermeyi planladığınız anlatımlı gösterimi kaydetmek ve notun kendisi haline gelmesini sağlamaktır.

Hinto AI, bir Loom, bir Zoom görüşmesi, bir YouTube videosu veya yerel bir MP4 olsun, herhangi bir video kaynağını alır ve web uygulamasından veya Chrome uzantısından ekranınızı kaydeder. AI eylem algılama özelliği, arayüz durumu değişikliklerini ve düğme tıklamalarını tanımlayarak ekran görüntüleri ve yazılı adımlar çıkarır. Bu adımlar yeni özellik, iyileştirme ve hata düzeltmesi maddelerine dönüşür; GIF motoru ise arayüzün değiştiği alanları kapsar. Hinto, ürün demolarından hazırlanan sürüm notları için tasarlanmış bir "Yenilikler" proje şablonu sunar.

Buradan sonra taslak hazırlamak yerine düzenlersiniz: bir bölümü seçip AI'dan yeniden yazmasını isteyin, ardından sonucu özel bir alan adıyla herkese açık bir URL'de barındırın veya Notion, Confluence, GitHub ya da GitLab'a senkronize edin.

Sürüm Notları Şablonu SSS

Sürüm notları neler içermeli?

On bir bölüm: bir üst bilgi satırı; değişikliklerin özeti; yeni özellikler; iyileştirmeler; hata düzeltmeleri; kırıcı değişiklikler ve geçiş adımları; bilinen sorunlar; yükseltme adımları; kullanımdan kaldırmalar; güvenlik notları; ve yardım alma bilgisi. Özet, göz gezdirenlerin okuduğu ve ajanların alıntıladığı satırdır.

İyi sürüm notları nasıl yazılır?

Okuyucunun artık yapabildiği şeyle başlayın, uygulama ayrıntısını dışarıda bırakın. "Toplu işleme uygulandı" ifadesi "Artık işlemin zaman aşımına uğramasına gerek kalmadan büyük veri kümelerini dışa aktarabilirsiniz" olur. Özellik adını kalın yazın, Yeni, İyileştirildi ve Düzeltildi etiketlerini kullanın ve maddeleri iki üç cümleyle sınırlı tutun.

Sürüm notlarını genellikle kim yazar?

Mühendisliğin teslim ettiği bilgilerle çalışan bir ürün yöneticisi veya ürün pazarlama yöneticisi. Mühendislik ekibi yayın günlüklerini sağlar, PM veya PMM bunları kullanıcıya yönelik maddelere çevirir ve not çıkmadan önce tek bir isim onay verir.

Yama notları ile sürüm notları arasındaki fark nedir?

Yama notları, yalnızca düzeltme içeren bir sürüm için kısa biçimdir. Yeni özellikleri, iyileştirmeleri, kullanımdan kaldırmaları ve yükseltme adımlarını çıkarır; düzeltmeyle, kimi etkilediğiyle ve okuyucunun tepki vermesi gerekip gerekmediğiyle başlar. Sürüm notları ise bir özellik sürümü için tam yapıyı taşır.

Jira'da sürüm notları nedir?

Bu, belirli bir yüzeye yapıştırılmış aynı dokümandır. Jira, Confluence, GitHub, Notion veya Azure DevOps hakkında soru soranlar sürüm notunun kendisini ister; bu yüzden yukarıdaki şablonu ekibinizin zaten okuduğu yüzeye kopyalayın. Hinto, Notion, Confluence, GitHub ve GitLab'a yayınlar.