Bu kılavuzun amacı, kurumların daha iyi belgelerle ne tür sorunların çözülebileceğini ve belge 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
Bir metrik seçmeye başlamadan önce, çözmeye çalıştığınız sorunu iyice 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 vazgeçip ayrılıyor."
- "Hata kodlarını anlama konusunda yardım almak için çok fazla sayıda sorunun 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 insanlar huysuz 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, dokümanlarda hata kodlarıyla ilgili bilgi bulamadıkları için sorunları açmak zorunda."
- "Sağlayıcımızın plan sınırlamaları ve zaman aşımları nedeniyle CI/CD testlerimiz başarısız oluyor."
- "Toplantılar kendi zaman dilimlerinde 05:30'da yapıldığı 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 bunu kontrol edebilirdi. İnceleme uzmanları neleri kontrol edeceklerini bilir. Yorumcuların ve katkıda bulunanların biçimlendirme, üslup ve stil hakkında tartışması gerekmez."
- "Hata kodu dokümanlarımız olsaydı kullanıcılar, sorunları açmak yerine yanıtlarını orada 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."
Spesifik olun
Sorunu sayısal olarak ifade edebilir misiniz?
- "PR'lerin birleştirilmesi çok uzun sürüyor" ne anlama geliyor? İki ay mı? İki hafta mı? Katkıda bulunanlar, vazgeçmeden önce incelenmek üzere ne kadar süre bekleyecek?"
- "Hata koduyla ilgili kaç sorun "çok fazla sorun" olarak kabul edilir?"
- "Hımmm... "çok huysuz" ne kadar huysuz?"
Ölçülebilirliği kontrol et
Önerilen metriğinizi 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 devasa PR'ler için birleştirme süresini ölçmek istiyoruz."
- "Hata kodu dokümanlarımızın kaç ziyaret aldığını kontrol edebilir ve bu sayının, açılan sorun 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. İki haftada bir ölçüyoruz."
- "Hata kodu ile ilgili sorunların sayısını her gün güncellemek pek mantıklı değil çünkü bir sorunu genellikle bir hafta içinde kapatıyoruz. 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 halkla ilişkiler kurma hedefimize bir aydan daha kısa sürede ulaşırsak başarıya ulaşabiliriz. 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. Ancak, açılan hatalarla ilgili sorunlarda% 50 oranında düşüş görecek olursak projemizin başarılı olduğunu düşünürüz."
İlgili bilgiler
- Raporlarla ilgili görevleriniz konusunda yardım almak için kuruluş yöneticisi kılavuzunu inceleyin.