Projeniz için doğru metrikleri seçme

Bu kılavuzun amacı, kuruluşların daha iyi belgelerle ne tür sorunların çözüleceğini ve belge projeleri için uygun metriklerin nasıl seçileceğini anlamalarına yardımcı olmaktır.

Mevcut aşama:
Belge geliştirme Zaman çizelgesini inceleyin.

Sorununuzu belirtin

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 pull isteklerinin birleştirilmesi çok uzun sürüyor. Katkıda bulunanlar pes edip gidiyorlar."
  • "Hata kodlarını anlama konusunda yardım almak için çok fazla sorunun açıldığını görüyoruz."
  • "CI/CD ardışık düzenimiz kesintili. Çok fazla test, tam olarak anlaşılmayan nedenlerle başarısız olur."
  • "Haftalık toplantılarımızda herkes huysuz görünüyor."

Hipotez geliştirme

Neden ve sonuç arayın. Belirttiğiniz sorunun nedeni ne olabilir? Sorunların birden çok veya örtüşen nedeni olabileceğini unutmayın.

  • "Stil hakkında net bir yönergemiz olmadığından ilk katılım dokümanları için pull isteklerinin birleştirilmesi çok uzun sürüyor. İncelemeciler ya ne yapılacağını bilmedikleri için PR'yi incelemeyi ertelediler veya biçimlendirme konusunda katkıda bulunanlarla birlikte ileri geri dolaşıyorlar."
  • "Kullanıcılar dokümanlarda hata kodlarıyla ilgili bilgi bulamadıkları için sorunları açmak zorunda kalıyorlar."
  • "Sağlayıcımızın plan sınırlamaları ve zaman aşımlarıyla karşılaşması nedeniyle CI/CD testlerimiz başarısız oluyor."
  • "Toplantılar kendi saat dilimlerine göre 05:30'da yapıldığından insanlar haftalık toplantılarımızda huysuz oluyor."

Çözüm önerin

Bu, yeni veya daha iyi dokümanlar ile çözülebilecek bir sorun mu?

  • "Bir stil rehberimiz olsaydı, bunu yapan kişiler PR'lerini göndermeden önce bunu kontrol edebiliyordu. İnceleme ekibi neleri kontrol edeceğini 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 sorunları açmak yerine cevaplarını orada bulabilirdi."
  • "Daha iyi belgeleme CI/CD sorunumuzu çözecek gibi görünmüyor."
  • "Her toplantıya taktik şakayla başlayabiliriz. Tık tık şakalarından bir koleksiyon oluşturmak, toplantılarımızı neşeli bir şekilde başlatmamıza yardımcı olur."

Spesifik olun

Sorunun sayısını söyleyebilir misiniz?

  • "'PR'lerin birleştirilmesi çok uzun sürer' tam olarak ne anlama geliyor? İki ay mı? İki hafta mı? Katkıda bulunanlar pes etmeden önce inceleme için ne kadar süre bekleyecektir?"
  • "Hata koduyla ilişkili kaç sorun 'çok fazla sorun'?'
  • "Hmmm ... 'çok huysuz' ne kadar huysuz?"

Ölçülebilirliği kontrol edin

Teklif ettiğiniz metriği nasıl kontrol edersiniz? Kolay ve doğru bir şekilde ölçülebilir mi? Ölçüm, ölçümü kimin yaptığına bağlı mı?

  • "Bir pull isteğinin ne kadar süredir açık olduğunu ve inceleme isteğinden bu yana geçen süreyi kolayca ölçebiliyoruz. Katkıda bulunanın ne zaman pes ettiğini tam olarak ölçemeyiz."
  • "Kaç sorunun 'hata kodu' olarak etiketlendiğini sayabilir veya hata kodu metni için sorunlar içinde arama yapabiliriz."
  • "İnsanların huysuzluğunu dokunsal veya doğru bir şekilde ölçemeyiz."

İkincil metrik ekleyin

Belgelerinizin sorununuzu çözüp çözmediğini anlamanıza yardımcı olacak başka metrikler var mı? Hedef metriğiniz her durumda aynı mı?

  • "Daha uzun PR'lerin incelenmesi daha uzun sürer; farklı PR'ler için farklı eşiklerin olması gerekir. Küçük, orta, büyük ve devasa halkla ilişkiler (PR'ler) için birleşme süresini ölçmek istiyoruz."
  • "Hata kodu belgemizin kaç ziyaret aldığı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 ölçekli PR'leri birleştirmek için iki hafta makul bir süre olduğunu düşünüyoruz ve tüm halkla ilişkiler bir ay içinde birleştirilmelidir. İki haftada bir ölçüm yapacağız."
  • "Hata koduyla ilgili sorunların sayısını günlük olarak güncellemek bir anlam ifade etmiyor, çünkü bir sorunu genellikle bir haftayla kapatmamız gerekiyor. Bunu haftalık olarak ölçeceğiz."

Hedef ayarla

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

  • "Her yeni halkla ilişkiler kurma hedefimize bir aydan daha kısa sürede ulaşma hedefimize ulaşabilirsek bu büyük bir başarı olurdu. Büyük çaplı 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. Ama hatalarla ilgili açılan sorunlarda% 50’lik bir düşüş görürsek projemizi başarılı kabul ederiz."