Projeniz için doğru metrikleri seçme

Bu kılavuz, kuruluşların daha iyi dokümanlar sayesinde ne 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:
2021 Belge Sezonu programı 14 Aralık 2021'de sona erdi. 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 belgelerimiz için çekme isteklerinin birleştirilmesi çok uzun sürüyor. Katkıda bulunanlar pes ediyor."
  • "Hata kodlarını anlama konusunda yardım almak için çok fazla sorun açıldığını görüyoruz."
  • "CI/CD ardışık düzenimizde kesintiler yaşandı. Çok fazla test, anlaşılmayan nedenlerle başarısız oluyor."
  • "Haftalık toplantılarımızda katılımcılar keyifsiz görünüyor."

Hipotez geliştirme

Neden sonuç ilişkisini bulmaya çalışın. Belirttiğiniz soruna neyin yol açmış olabileceğini düşünüyorsunuz? Sorunların birden fazla veya çakışan nedeni olabileceğini unutmayın.

  • "Stil hakkında net bir yönlendirmemiz olmadığı için ilk katılım belgeleri için çekme isteklerinin birleştirmek çok uzun sürüyor. İnceleme uzmanları, ne yapacaklarını bilmedikleri için PR'yi incelemeyi erteliyor veya biçimlendirme konusunda katkıda bulunanlarla sürekli iletişim halinde oluyor."
  • "Kullanıcıların, dokümanda hata kodları hakkında bilgi bulamadığı için sorun açması gerekiyor."
  • "Sağlayıcımızın plan sınırlamaları ve zaman aşımları nedeniyle CI/CD testlerimiz başarısız oluyor."
  • "Haftalık toplantılarımız kendi saat dilimlerine göre sabah 5:30'da olduğu için insanlar huysuz yaşıyor."

Çö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 bunu kontrol edebilirdi. İnceleme uzmanları neleri kontrol edeceklerini bilir. İncelemeciler ve katkıda bulunanlar biçimlendirme, üslup ve stil konusunda tartışmak zorunda kalmaz."
  • "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 derleyebiliriz."

Ayrıntılı bilgi verin

Sorunu sayısal olarak ifade edebilir misiniz?

  • "'PR'lerin birleştirilmesi çok uzun sürer' gerçekten 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 ne kadar süredir açık olduğunu ve inceleme isteğinin ne kadar süre önce gönderildiğini 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 hassas 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 büyük PR'ler için birleştirme süresini ölçmek istiyoruz."
  • "Hata kodu belgemizin aldığı ziyaret sayısını kontrol edebiliyor ve bu sayının açılan daha az sorunla ilişkili olup olmadığını görebiliyoruz."

Zaman aralığı seçin

  • "Küçük ve orta büyüklükteki PR'leri birleştirmek için iki haftanın makul bir süre olduğunu düşünüyoruz ve tüm halkla ilişkiler kurumlarının bir ay içinde birleştirilmesi gerekiyor. 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 kapatma hedefimize ulaşabilirsek bu bir başarı olur. Büyük PR'leri kapatma ortalama süremiz iki hafta kısalsa bu büyük bir başarı olur."
  • "İdeal olarak, hatayla ilgili yeni bir sorunla karşılaşmayız. Ama hatalarla ilgili açılan konularda% 50 oranında bir düşüş görürsek projemizin başarılı olduğunu düşünürüz.”