Ücretsiz sürüm notları oluşturucu

Sürüm notları nedir?

Sürüm notları, bir ürünün yeni sürümünde nelerin değiştiğinin kısa bir özetidir: yeni özellikler, iyileştirmeler ve düzeltmeler; okuyucunun artık neler yapabileceğini bilmesini sağlayacak şekilde yazılır. Sürüm notları oluşturucu, ekibinizin elinde zaten bulunan commit veya bilet gibi ham listeleri bu özete dönüştürür, böylece notlar bir hafta sonra değil, sürümle birlikte yayınlanır.

İyi sürüm notları, müşterilere bir güncellemenin neden önemli olduğunu anlatır. Commit mesajları ise geliştiricilere hangi kodun değiştiğini söyler. İş, birini diğerine çevirmektir.

Sürüm notları mı, değişiklik günlüğü mü?

İnsanlar bu kelimeleri esnek kullanır. Faydalı bir ayrım:

Bu araç aynı zamanda bir değişiklik günlüğü oluşturucu olarak da çalışır: her sürüm için notlar oluşturun ve bunları değişiklik günlüğü sayfanızın en üstüne ekleyin.

Sürüm notlarına neler dahil edilmeli

• Ürün ve sürüm içeren başlık: “Acme Analytics 3.2 sürüm notları”.
• Tek satırlık özet: okuyucuların çoğunun önemsediği bir veya iki değişiklik.
• Yeni, İyileştirilmiş, Düzeltilmiş: bu sırada, boş bölümleri çıkararak.
• Fayda odaklı maddeler: kodun ne yaptığı değil, kullanıcının artık ne yapabildiği.
• Kırılma yaratan değişiklikler: birinin yapması gereken tam olarak neyse, açıkça belirtilmiş.
• Bağlantılar: açıklanması gereken her şey için yardım makalesine veya videoya.

Kısa bir sürüm notu örneği

Üç commit; “feat: export reports to CSV”, “fix: dashboard timezone off by one hour” ve “chore: bump dependencies”, şuna dönüşebilir:

Acme Analytics 3.2
Artık raporlarınızı her yere götürebilir ve panellerde doğru saatleri görebilirsiniz.

Yeni

• CSV dışa aktarma: herhangi bir raporu Excel veya Google E-Tablolar'da açmak için CSV dosyası olarak indirin.

Düzeltilmiş

• Panel saatleri: grafikler artık saat diliminizi doğru şekilde kullanıyor.

Bağımlılık güncellemesi müşteri sürümünde yer almaz, çünkü kullanıcılar bunu fark etmeyecektir. İç sürüm ise bunu tutar.

Değişikliklerinizi oluşturucu için nasıl hazırlarsınız

Listenizi önce temizlemenize gerek yok, ancak birkaç alışkanlık daha iyi notlar sağlar. Commit mesajı, bilet başlığı veya bir cümle olsun, her değişikliği satır satır yapıştırın. Kullanıyorsanız “feat:” ve “fix:” gibi geleneksel önekleri koruyun; bunlar değişiklikleri yeni ve düzeltilmiş olarak ayırmaya yardımcı olur. Karmaşık öğelere bir kelimelik bağlam ekleyin, örneğin “fix: export (CSV was empty for large reports)”. Başlığın yayınlanmaya hazır olması için ürün adını ve sürümü doldurun. Ardından her iki sürüme de ihtiyacınız varsa iki kez çalıştırın: bir kez müşteriler için, bir kez iç ekip için.

Sürüm notları için en iyi uygulamalar

Ürünü kullanan kişi için yazın

“Raporlar daha hızlı yükleniyor”, “Sorgu planlayıcı optimize edildi”den daha iyidir. Özelliği arayüzde göründüğü gibi adlandırın.

En önemli olanla başlayın

İnsanların çoğunun fark edeceği değişikliği en başa koyun. Küçük düzeltmeler sonunda her biri bir satır olabilir.

Yeni özelliği gösterin

Yeni bir özelliğin ekran görüntüsü veya kısa bir videosu, bir paragraftan daha fazlasını anlatır. Açıklayan yardım makalesine bağlantı verin.

İnsanların bulabileceği bir takvimde yayınlayın

Her sürümü tek bir değişiklik günlüğü sayfasında, en yenisi en üstte olacak şekilde tutun, böylece müşteriler ve destek ekibiniz nereye bakacaklarını her zaman bilir.

Yaygın sürüm notu hataları

• Commit günlüğünü bilet numaraları ve jargonla olduğu gibi yapıştırmak.
• Kırılma yaratan bir değişikliği listenin ortasında gizlemek.
• Müşteri notlarında her iç değişikliği listelemek.
• Sürümde olmayan tarihleri veya özellikleri vaat etmek.

Oluşturucu yalnızca listenizdeki değişiklikleri içerir ve vermediğiniz tarihleri eklemez, ancak yayınlamadan önce her öğeyi kontrol edin.