Bu sayfa, Google Dokümanlar Sezonu için kabul edilen teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- Mautik
- Teknik yazar:
- Şeker Kumsal
- Proje adı:
- Mautic'in Son Kullanıcı dokümanlarını inceleme ve güncelleme
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Mevcut belgeleri incelerken edindiğim ilk izlenimler:
Şu anda belgeler uzundur, birçok yerde gereksizdir, eksik ve düzensizdir. Bu da kullanıcıların aradıkları bilgiyi bulmalarını zorlaştırabilir.
İlk kez kullanan bir kullanıcı olarak, Mautic'in Kampanyalar, öğeler, mesajlar, kategoriler gibi farklı öğelerinin, işle ilgili bir ihtiyacı çözmek için nasıl bir araya geldiğini anlayamıyordum. Her Mautic öğesini 2-3 satırda açıklayan yüksek seviyede bir kavramsal konuya sahip olmasını öneriyorum. Bu konu, söz konusu öğelerin her biri için çeşitli ayrıntılı görev konularına bağlantı verebilir.
Katkıda bulunan kılavuzun kapsamı genişletilebilir. Bu kılavuz; bir sorunun nasıl açılacağı, yeni içerik/fikirlerin nasıl önerileceği, hataların/sorunların/güvenlik açıklarının nasıl bildirileceği vs. gibi daha fazla bilgi içerecek şekilde genişletilebilir. Bunun için forumlara, Slack kanallarına ve git kod depolarına bağlantılar sağlanabilir. Ayrıca stil kılavuzunun, standart tipografik kurallar, resimlere, tablolara ilişkin yönergeler vb. eklenmesi için genişletilmesi gerekir.
Dahası, E-postalar'da, Kampanyalarda ve güncellenmesi gereken eski/güncel olmayan birçok bilgi bulunuyor.
Katkıda bulunmak istediğim alan:
Kullanıcıların Mautic topluluğuyla doğrudan etkileşim kurduğu Slack kanallarındaki tartışmaları incelerken, Kampanyaların ve E-postaların Mautic'in önemli öğeleri olduğunu fark ettim. Sürüm 3 için Mautibox'ı kullanarak Kampanyalar ile ilgili dokümanları test ettim ve yoğun bir şekilde yenilenmesi gerektiğini keşfettim. Bulduğum sorunlardan bazıları ve her biriyle ilgili teklifimi aşağıda bulabilirsiniz:
- Mautic kullanıcısı, kampanya oluştururken çeşitli eylemler, kararlar ve koşullar arasından seçim yapabilir. Birçok eylem ve karar için söz konusu belgeler eksikken kampanya koşullarıyla ilgili neredeyse hiçbir belge bulunmamaktadır. Eksik bilgileri belirleyip son kullanıcı dokümanına eklememiz gerekir.
- Kampanyalar basit veya son derece karmaşık olabilir. Mevcut dokümanlar, kampanyaları ilk kez oluşturan kullanıcılar için fazla bir değer katmıyor. İlk kez kullananların kendi kampanyalarını oluşturmaya başlamadan önce bakabilecekleri bazı kullanım alanlarını (basit ve karmaşık) belirlemeyi ve örnek iş akışları oluşturmayı (adım adım açıklamalı eğitimler şeklinde veya son kullanıcı kılavuzundaki konular ya da adım adım açıklamalı videolarda) oluşturmanızı öneriyorum.
- Bu bölümde bilgilerin daha düzenli ve düzenli bir şekilde sunulması gerekir. Kullanılabilirliği artırmak için göreve ve kavrama dayalı yaklaşım benimsenmelidir. Konularda işlemler, kararlar ve koşullar hakkında bilgi sunmak için tablolar kullanılabilir. "Tarih tetikleyicilerini kullanma" konusu pek alakasız görünüyor. Koşullar altında iç içe yerleştirilebilir.
Kampanyalar'ın yanı sıra, e-postalara ilişkin dokümanları da kullanıcı arayüzünde test ettim. İşte üzerinde çalışmayı öneriyorum:
- E-postalar için Dinamik İçerik, özel kod e-posta şablonları (hem Şablonlar e-postaları hem de Segment e-postaları için) için kullanılabilir ancak şu anda bununla ilgili herhangi bir doküman bulunmamaktadır. Dinamik içeriğin ne işe yaradığı ve nasıl ayarlanacağıyla ilgili ayrıntıları birkaç örnekle ekleyin.
- Monitoring e-postaları için ayrı bir konu ekleyin. Bu bilgiler arasında, gösterge tablosunda bulunan e-posta widget'larının kullanımı ve bunların e-postayla ilgili metrikleri ve etkinlikleri izlemek için nasıl kullanılabileceği hakkında bilgiler yer alabilir. Ayrıca, takip e-postaları hakkındaki bilgileri buraya taşıyın.
- Dokümanlarda, kişi yanıtları, geri dönme yönetimi, e-postanın sahibi olduğu, E-posta Ayarları altında yapılandırılabilen genel yapılandırma ayarları olduğu açıklanmıyor. Tüm E-posta ayarları bir şemsiye konu altında olmalıdır. Ayrıca varsayılan sıklık kuralları ve e-posta listesinden çıkma ayarları gibi diğer e-posta ayarları hiç belgelenmemiştir. Hangi ayarların zorunlu veya isteğe bağlı olduğunu belirtin.
- Hemen çıkma yönetimi sayfasından Webhook'lar ile ilgili tüm bilgileri kaldırın ve Webhook'lar için ayrı bir konuya yerleştirin. Buradan, bu konuyla ilgili bir bağlantı sağlayabiliriz.
Ayrıca: - Gösterge Tablosu konusunda, kullanılabilir widget'larla ilgili eksik bilgiler var. Kullanıcıların Mautic kaynaklarını analiz edip izlemesine yardımcı olan bu bilgilerin eklenmesi önemlidir.
Boşlukları tespit etmek için belgenin tamamının takılması gerekir. Dokümanı, kullanıcılarımızın daha rahat erişebileceği bir hale getirmek için yenilememiz gerekiyor.
Bilgimin/deneyimimin bu proje için nasıl faydalı olmasını bekliyorum?
Geçtiğimiz ay Mautic 3.0 sürümü için destek ekleme de dahil olmak üzere Mautic dokümanlarındaki çeşitli sorunlar üzerinde çalıştıktan sonra son kullanıcı dokümanlarının yapısı hakkında bilgi edindim ve dokümanlardaki eksiklikleri tespit ettim. Dokümanlarımızdaki eksiklikleri nasıl giderebileceğimizi anlamak için zamanımı diğer pazarlama otomasyonu araçlarıyla ilgili belgeleri araştırarak ve bunları Mautic son kullanıcı dokümanlarıyla karşılaştırarak harcadım. HTML dili, açık kaynak araçlar ve süreçlere aşina olmam ek bir avantaj. Şu anda kullanıcı deneyimi araştırmalarıyla ilgili bir kursa devam ediyorum ve bu ilkelerden yararlanarak daha kullanıcı odaklı dokümanlar oluşturabiliyorum. Ayrıca, bilgi mimarisi deneyimim sayesinde içeriği düzenleyebilecek ve dokümanlarımızı kullanıcı hedefleriyle uyumlu hale getirecek fikirler sunabileceğim. Buna ek olarak, yeni teknik alanlarla ilgili bilgimi genişletme konusunda da ustayım. 10 yıllık teknik yazım deneyimim ve GSOD'un benim için tamamen yeni olan bir kuruluşta bir projeyi başarıyla tamamlama tecrübesi sayesinde, Mautic belgelerine yaptığım katkı konusunda adaletli olabileceğimden eminim.