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


Yanıtlar:


21

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.


1
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.

5

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.


4
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
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.