Projeniz için doğru metrikleri seçme

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

Mevcut aşama:
Sonuçlar açıklandı. 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 alınabilmesi için birçok sorunun açıldığını görüyoruz."
  • "CI/CD ardışık düzenimiz kesintili. Çok fazla test, tam anlaşılmayan nedenlerle başarısız oluyor."
  • "Haftalık toplantılarımızda insanlar 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 belgeleri 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, belgelerde hata kodlarıyla ilgili bilgi bulamadıkları için sorunları açmak zorunda kalıyor."
  • "Sağlayıcımızdan kaynaklanan plan sınırlamaları ve zaman aşımlarıyla karşılaştığımız için 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 kalmazdı."
  • "Hata kodu dokümanlarımız olsaydı kullanıcılar soruları açmak yerine cevaplarını orada bulabilirdi."
  • “Daha iyi belgeleme CI/CD sorunumuzu çözecek gibi durmuyor.”
  • "Her toplantıya bir "tık tık" esprisiyle başlayabiliriz. Tık tık şakalarından bir koleksiyon oluşturmak, toplantılarımıza gülümseyerek başlamamıza yardımcı olur."

Spesifik olun

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

  • "'PR'lerin birleştirilmesi çok uzun sürüyor' 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 birinin ne zaman pes ettiğini tam olarak ölçemeyiz.”
  • "Kaç tane sorunun 'hata kodu' olarak etiketlendiğini sayabilir veya hata kodu metni için sorunlar içinde arama yapabiliriz."
  • "İnsanların huysuzluğunu dokunsal ve 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şiklerimizin olması gerekir. Küçük, orta, büyük ve muazzam halkla ilişkiler için birleşme süresini ölçmek istiyoruz."
  • "Hata kodu belgelerimizin 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 PR'lerin bir ay içinde birleştirilmesi gerekiyor. İki haftada bir ölçüm yapıyoruz."
  • "Hata koduyla ilgili sorunların sayısını günlük olarak güncellemek bir anlam ifade etmiyor, çünkü bir sorunu genellikle bir hafta kapatmamız gerekiyor. Bunu haftalık olarak ölçüyoruz."

Hedef ayarla

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

  • "Her yeni halkla ilişkiler sürecini bir aydan kısa sürede kapatma hedefimize ulaşırsak başarılı oluruz. Büyük çaplı PR'leri kapatma ortalama süremiz iki hafta azalırsa büyük bir başarı elde ederiz."
  • "İdeal olarak, hatalarla ilgili yeni bir sorun görmedik. Fakat hatalarla ilgili sorunlarda% 50’lik bir düşüş görürsek projemizi başarılı kabul ederiz.”