Sürüm notları yazmanın iyi uygulamaları

Yazılımın her sürümünün tesliminde bir sürüm notu yazmamız gerekir. Örneğin, bir sürüm notu yazarken eklediğim terimlerden bazıları şunlardır:

Yayın tarihi
Hata Çözüldü

Bu yeterli mi, yoksa başka bir şey var mı?

release

— CoolProgrammer
kaynak

Kopyası gibi bu görünüyor programmers.stackexchange.com/questions/66377/...

eklenen özellikleri unutmayın

— cırcır ucube

Yanıtlar:

Aşağıdaki iyi uygulamalara yol açacağını düşünüyorum

// İlgili Tarih

Yayın tarihi

// Özelliklerle ilgili

Eklenen Özellikler
Öne Çıkanlar Kaldırıldı
Değişen Özellikler

// Hata ile ilgili

Çözülen Hatalar
Çözülmemiş Hatalar

// Bağımlılıkla ilgili

Bağımlılık listesi

// Test ile ilgili

Birim Test sonuçları
Kabul Testi sonuçları

// Sürüm kontrolü ile ilgili

Etiket Notu
Revizyon numarası

Ayrıca son kullanıcının yapılandırmalarında veya iş akışında değiştirmek isteyebilecekleri şeyleri vurgulamaya değer.

Çoğu son kullanıcı test sonucunu umursamıyor. Sürüm notu ne olursa olsun, yüksek kalitede olmasını bekliyorlar.

Sürüm notlarıyla ilgili en önemli şey, her ek cümlenin okuyucuların% 10'unu daha kaybettiğinin farkında olmaktır. Dolayısıyla, mevcut kullanıcılarınızın sürüm hakkında bilmesi gereken şeylere kesinlikle öncelik vermelisiniz.

— Md Mahbubur Rahman
kaynak

ayrıca son kullanıcının yapılandırmalarında veya iş akışında değiştirmek isteyebilecekleri şeyleri vurgulamaya değer

— jk.

@jk. Evet haklısın. Cevabınızı iyi yorumunuz olarak düzenledim.

— Md Mahbubur Rahman

Çoğu son kullanıcı test sonucunu umursamıyor. Sürüm notu ne olursa olsun, yüksek kalitede olmasını bekliyorlar.

— Henrik

@Henrik sürüm notları son kullanıcılar dışındaki kişiler için yararlı olabilir

— jk.

Sürüm notlarıyla ilgili en önemli şey, her ek cümlenin okuyucuların% 10'unu daha kaybettiğinin farkında olmaktır. Dolayısıyla, mevcut kullanıcılarınızın sürüm hakkında bilmesi gereken şeylere kesinlikle öncelik vermelisiniz.

— ddyer
kaynak

her satır sıradan, ilgisiz (veya tembel) okuyucuların% 10'unu kaybedebilir. Bu okuyucular, sürüm notlarınızın yazılmadığı okuyuculardır. Yaptıklarınızı önemseyenler, hepsini okuyacak ve her ilgili satır için teşekkür edeceklerdir - sadece belgelere düzgün bir şekilde girmesi gereken tüyleri dahil etmek konusunda dikkatli olmanız gerekir.

— gbjbaanb