docs.microsoft.com’a Yeni Bir Geri Bildirim Sistemi Geliyor

Bu gönderi, docs.microsoft.com ekibinin Üst Düzey Program Yöneticisi olan Rob Eisenberg tarafından yazıldı.

Microsoft'un misyonu dünya üzerindeki tüm insan ve kurumlara daha fazlasını başarma gücünü vermektir. Açık GitHub platformunun üzerine docs.microsoft.com'u yapılandırırken düşündüğümüz konulardan biri de buydu. Bugün, yeni bir GitHub tabanlı belgeler geri bildirim sistemine geçiş ile işleri bir adım ileri taşıyoruz.

GitHub’da İçerik Geri Bildirimi

Belgelerimiz en başından beri GitHub üzerinde olsa da, makalelerle ilgili yorumlar için içerik geri bildirimi mekanizmamızda Livefyre kullanılıyordu. Livefyre yorumlar için harika bir çözüm ama izleme, sahipleri atama ve müşterilerin gönderdiği içerik sorunlarının durumuyla ilgilenme gibi özel gereksinimlerimiz için yetersiz kaldı.

Bunu daha iyi hale getirmek için çeşitli yolları inceledik ama çalışmalarımıza büyük ölçüde yol gösteren tek bir soru sürekli yeniden karşımıza çıktı: Belgelerimiz aynı açık kaynak kodu gibi değerlendirilirse, bu sorunu çözmek için ne kullanabiliriz? Bu sorunun yanıtı gayet açık görünüyordu: GitHub Sorunları. Dolayısıyla, GitHub altyapısının üzerine tam bir geri bildirim sistemi kurabilmek için GitHub API'lerini belge sayfalarımıza daha derinden tümleştirme denemelerine başladık.

Yeni sistemle, artık doğrudan içerik sayfasından GitHub sorunları oluşturabiliyor, bu sayede yazarlar ve ürün ekipleriyle çok daha zengin bir etkileşim kurabiliyorsunuz. Belgede bir sorunla mı karşılaştınız? Hatalı bir kod örneği mi var? Bir açıklama kafanızı mı karıştırdı? Kritik bir eksik mi var? Sayfanın altına kaydırın ve Belge geri bildirimi sağlayın öğesini seçin.

Oturum açan ve geri bildirim bırakan kullanıcı

Belgeyle ilişkili olarak tüm açılan ve kapatılan sorunları doğrudan belge sayfasından görebilir, böylelikle sorunların düzeltildiğini ve çözüldüğünü her zaman yakından izleyebilirsiniz:

Açılan ve kapatılan sorunları gösterme

Sizin için önemli olan sorunlar üzerinde yorum yapabilir, hatta bunlarla ilgili tepkilerinizi ekleyebilirsiniz:

GitHub sorunlarıyla ilgili tepkileri ekleme

Artık, Microsoft çalışanları raporlanan sorunları önceliklendirmek, yanıtlamak, planlamak ve düzeltmek için GitHub Sorunları'nın tüm gücünden yararlanabilir ve her zaman süreci görebilirsiniz!

Örnek belge geri bildirimi

Bir makaledeki bozuk bir köprüyle ilgili bir GitHub sorunu kaydettiğinizi varsayalım. Ekibimiz sorunu önceliklendirir, soruna bir etiket atar ve düzeltmeyi yapacak (veya takip soruları soracak) olan bir sahip belirler. Sorunun sahibi sorunu düzelten bir çekme isteği gönderdiğinde, sorunun çözüldüğü/kapatıldığı size bildirilir (GitHub bildirim ayarlarınız temelinde). Bu şekilde verimli bir geri bildirim döngüsü oluşturulur.

Bunların yanı sıra, yorumlardaki Markdown, tek tek sorunlara veya depoların tamamına abonelikler, kuruluş etkinliğinin RSS akışları, @ bahsetmeler, atananlar gibi daha birçok standart GitHub avantajından da yararlanabilirsiniz! Açık kaynak aracına daha derin bir tümleştirmenin, topluluğun büyümesi ve işbirliği için yeni fırsatları teşvik edeceğine inanıyoruz.

Ürün Geri Bildirimi Ayrımı

Önceki sistemin sorunlarından biri ürün ve belge geri bildirimlerini tek bir akışta karma olarak bulundurmasıydı. Öğelerin tümü tutarlı bir şekilde etiketlenmediğinde önceliklendirmek ve takip etmek son derece zordu. Biz bir adım ileri gidip ikisi arasında ayrım yapmak için net bir yöntem oluşturarak bu sorunu çözdük:

Ürün geri bildirimleri gönderme

Şimdi Ürün geri bildirimi sağlayın öğesine tıkladığınızda doğrudan belirli bir belge sayfasıyla ilişkilendirilmiş olan ürün ekibinin ürün geri bildirimleriyle ilgilendiği siteye gidiyorsunuz.

Dağıtım

Geri bildirim sisteminin ne zaman canlı olacağını merak ediyor olabilirsiniz. Şimdilik Visual Studio IDE ve Azure CLI belgeleri için birkaç ay boyunca pilot bir uygulama yapacağız. Şubat ayının ortasından başlayarak, bunu tüm docs.microsoft.com'a dağıtacağız.

Geri Bildiriminiz

Geri bildirimlerinize önem veriyoruz, bu nedenle de bu yeni sistemi hızla kullanımınıza sunmak istiyoruz. Bu, platformumuzda geri bildirim ve katılımı geliştirmeye yönelik bir sonraki adımımız, ama kesinlikle son adım değil. UserVoice'da düşüncelerinizi dile getirmeyi unutmayın veya Twitter'da bizi etiketleyin.