Projeniz için doğru metrikleri seçme

Bu kılavuz, kuruluşların daha iyi dokümanlar sayesinde hangi tür sorunların çözülebileceğini ve doküman projeleri için uygun metriklerin nasıl seçileceğini anlamalarına yardımcı olmak amacıyla hazırlanmıştır.

Mevcut aşama:
Örnek olaylar yayınlandı. Zaman çizelgesine bakın.

Sorununuzu belirtin

Bir metrik seçmeye başlamadan önce, çözmeye çalıştığınız sorunu iyi anladığınızdan emin olun. Mümkün olduğunca ayrıntı vermeye çalışın.

  • "İlk katılım dokümanlarımızla ilgili çekme isteklerinin birleştirilmesi çok uzun sürüyor. Katkıda bulunanlar pes edip ayrılıyor."
  • "Hata kodlarını anlama konusunda yardım almak için çok fazla sorun açıldığını görüyoruz."
  • "CI/CD ardışık düzenimiz kararlı değil. Çok fazla test, anlaşılmayan nedenlerle başarısız oluyor."
  • "Haftalık toplantılarımızda ekip üyelerimiz huysuz görünüyor."

Hipotez geliştirme

Neden ve sonuç ilişkisine bakın. Belirttiğiniz soruna neyin neden olabileceğini düşünüyorsunuz? Sorunların birden fazla veya çakışan nedeni olabileceğini unutmayın.

  • "Oryantasyon dokümanları için gelen çekme isteklerini birleştirme işlemi çok uzun sürüyor. Bunun nedeni, stil konusunda net bir kılavuzumuzun olmaması. İnceleme uzmanları, ne yapacaklarını bilmedikleri için PR'yi incelemeyi erteliyor veya biçimlendirmeyle ilgili olarak katkıda bulunanlarla sürekli iletişim kuruyor."
  • "Kullanıcıların, dokümanda hata kodları hakkında bilgi bulamadığı için sorun açması gerekiyor."
  • "Sağlayıcımızdan plan sınırlamaları ve zaman aşımları aldığımız için CI/CD testlerimiz başarısız oluyor."
  • "Toplantılar kendi saat dilimlerinde 05:30'da olduğu için ekip üyelerimiz haftalık toplantılarımızda huysuz oluyor."

Çözüm önerme

Bu sorun, yeni veya daha iyi dokümanlar ile çözülebilir mi?

  • "Bir stil kılavuzumuz olsaydı, commit yapanlar PR'lerini göndermeden önce bu kılavuzu kontrol edebilirdi. İnceleme uzmanları neleri kontrol edeceklerini bilir. İnceleme uzmanlarının ve katkıda bulunanların biçimlendirme, üslup ve stil konusunda tartışması gerekmez."
  • "Hata kodu dokümanlarımız olsaydı kullanıcılar sorun kaydı açmak yerine bu dokümanlarda yanıtlarını bulabilirdi."
  • "Hmm, daha iyi dokümanlar CI/CD sorunumuzu çözmeyecek gibi."
  • "Her toplantıya bir şakayla başlayabiliriz. Toplantılarımıza gülümseyerek başlamak için şakalar derleyebilirsiniz."

Ayrıntılı bilgi verin

Sorunu sayısal olarak ifade edebilir misiniz?

  • "PR 'lerin birleştirilmesi çok uzun sürüyor" ifadesi ne anlama geliyor? İki ay mı? İki hafta mı? Katkıda bulunanlar, inceleme için ne kadar süre bekledikten sonra vazgeçer?"
  • "Hata koduyla ilgili kaç sorun "çok fazla sorun" olarak kabul edilir?"
  • "Hımmm… "çok huysuz" ne kadar huysuz?"

Ölçülebilirliği kontrol edin

Önerdiğiniz metriği nasıl kontrol edersiniz? Kolay ve doğru bir şekilde ölçülebilir mi? Ölçüm, ölçümü yapan kişiye bağlı mı?

  • "Bir çekme isteğinin açık kaldığı süreyi ve inceleme isteğinin gönderildikten sonra geçen süreyi kolayca ölçebiliriz. Katkıda bulunanların ne zaman vazgeçtiğini tam olarak ölçemiyoruz."
  • ""error-code" etiketli kaç sorunun olduğunu sayabilir veya sorunlarda hata kodu metnini arayabiliriz."
  • "Kullanıcıların sinirliliğini nazik veya doğru bir şekilde ölçemiyoruz."

İkincil metrik ekleme

Dokümanlarınızın sorununuzu çözüp çözmediğini anlamanıza yardımcı olacak başka metrikler var mı? Hedef metrikleriniz her durumda aynı mı?

  • "Daha uzun PR'lerin incelenmesi daha uzun sürer. Farklı boyutlardaki PR'ler için farklı eşikler belirlememiz gerekir. Küçük, orta, büyük ve devasa PR'ler için birleştirme süresini ölçmek istiyoruz."
  • "Hata kodu dokümanlarımızın kaç ziyaret aldığını kontrol edip bu sayının, açılan sorunların sayısının azalmasıyla ilişkili olup olmadığını görebiliriz."

Zaman aralığı seçin

  • "Küçük ve orta boy PR'lerin birleştirilmesi için iki haftanın makul bir süre olduğunu düşünüyoruz. Tüm PR'ler bir ay içinde birleştirilmelidir. Bu nedenle her iki haftada bir ölçüm yapacağız."
  • "Bir sorunu kapatma süremiz genellikle bir hafta olduğu için hata koduyla ilgili sorunların sayısını günlük olarak güncellemenin bir anlamı yoktur. Bunu haftalık olarak ölçeceğiz."

Hedef ayarla

Projenin başarılı olduğunu söylemek için seçtiğiniz metrikte ne kadar değişiklik görmeniz gerekir? Seçtiğiniz metrikler için nicel hedefler belirleyebilirsiniz.

  • "Her yeni PR'yi bir aydan kısa sürede tamamlama hedefimize ulaşabilirsek bu bir başarı olur. Büyük PR'leri kapatma ortalama süremiz iki hafta azalırsa bu büyük bir başarı olur."
  • "İdeal olarak, hatalarla ilgili yeni bir sorunla karşılaşmayız. Ancak, açılan hatalarla ilgili sorunlarda% 50 oranında düşüş görürsek projemizi başarılı olarak değerlendiririz."