Projeniz için doğru metrikleri seçme

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

Mevcut aşama:
Sonuçlar açıklandı zaman çizelgesi.

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 spesifik olun.

  • "İlk katılım dokümanlarımızla ilgili pull isteklerinin birleştirmek çok uzun sürüyor. Katkıda bulunanlar pes eder ve kaybolur."
  • "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 stabil değil. Çok fazla test, tam olarak anlaşılmayan nedenlerle başarısız oldu."
  • “İnsanlar haftalık toplantılarımızda huysuz görünüyor.”

Hipotez geliştirme

Sebep 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 kılavuzumuz olmadığından ilk katılım dokümanları için pull isteklerinin birleştirilmesi çok uzun sürüyor. İncelemeciler ya ne yapacaklarını bilmedikleri için PR'yi incelemeyi ertelediler veya biçimlendirme konusunda katkıda bulunanlarla birlikte ileri geri gidiyorlar."
  • "Kullanıcılar dokümanlarda hata kodlarıyla ilgili bilgi bulamadıkları için sorunları açmaları gerekiyor."
  • "Sağlayıcımızın 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 olduğu için insanlar haftalık toplantılarımızda huysuz oluyor."

Bir çözüm önerin

Bu, yeni veya daha iyi belgelerle çözülebilecek bir sorun mu?

  • "Stil rehberimiz olsaydı sorumlular PR'lerini göndermeden önce bunu kontrol edebiliyordu. İncelemeciler neyi kontrol edeceklerini bilir. İncelemeciler ve katkıda bulunanlar; biçimlendirme, üslup ve stil konusunda tartışmak zorunda kalmazlar."
  • "Hata kodu dokümanlarımız olsaydı kullanıcılar sorunları görüntülemek yerine cevaplarını orada bulabildi."
  • “Hmm, daha iyi bir belgeleme CI/CD sorunumuzu çözecek gibi görünmüyor.”
  • "Her toplantıya takk şakasıyla başlayabiliriz. Tık tık şakalarından bir koleksiyon oluşturmak, toplantılarımıza iyi bir başlangıç yapmamıza yardımcı olur."

Spesifik olun

Soruyu ifade edebilir 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 bekleyecek?"
  • "Hata koduyla ilgili kaç sorun 'çok fazla sorun var'?"
  • “Hmmm ... 'çok huysuz’ ne kadar huysuz?”

Ölçülebilirliği kontrol edin

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

  • "Bir çekme 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 vazgeçtiğini tam olarak ölçemiyoruz.”
  • "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 PR'ler için birleşme süresini ölçmek istiyoruz.”
  • "Hata kodu belgelerimizin kaç ziyaret aldığını ve bu sayının açılan daha az sorunla ilişkili olup olmadığını kontrol edebiliyoruz."

Zaman aralığı seçin

  • "Küçük ve orta ölçekli halkla ilişkiler (PR) ile birleşmek için iki haftada makul bir süre olduğuna inanı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 mantıklı değil çünkü sorunları genellikle bir hafta içinde kapatırız. 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 gerekir? Seçtiğiniz metrikler için niceliksel hedefler belirlemeyi düşünün.

  • "Her yeni halkla ilişkiler hedefini bir aydan kısa sürede kapatma hedefimize ulaşırsak başarılı oluruz. Büyük PR'leri kapatma ortalama süremiz iki hafta azalırsa bu büyük bir başarı olurdu."
  • "İdeal olan, hatalarla ilgili yeni sorunlar görmediğimizidir. Ama hatalarla ilgili açılan sorunlarda% 50'lik bir düşüş görseydik, projemizin başarılı olduğunu düşünürüz."