Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- Mautik
- Teknik yazar:
- Kocaeli
- Projenin adı:
- Mautic'in Son Kullanıcı belgelerini inceleme ve güncelleme
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Mevcut belgeleri incelerken edindiğim ilk izlenimler:
Şu anda dokümanlar uzun, birçok yerde gereksiz; eksik ve düzensiz. Bu da kullanıcıların aradıkları bilgiyi bulmalarını zorlaştırabiliyor.
İlk kez kullanan bir kullanıcı olarak, Mautic'in Kampanyalar, öğeler, mesajlar, kategoriler vb. farklı öğelerinin, işle ilgili bir ihtiyacı çözmek için nasıl bir araya geldiğini anlayamıyordum. Her bir Mautik öğeyi 2-3 satırda açıklayan üst düzey bir kavramsal konuya sahip olmayı öneriyorum. Bu konu sırayla bu unsurların her biri için çeşitli ayrıntılı görev konularına bağlantı verebilir.
Katkıda bulunan kılavuzun kapsamı genişletilebilir; bir sorun açma, yeni içerik/fikir önerme, hata/sorun/güvenlik açıklarını bildirme, vb. daha fazla bilgi sağlanarak forumlara, slack kanallarına ve git depolarına bağlantılar sağlanabilir. Ayrıca stil kılavuzunun, standart tipografik kurallar, resimlere, tablolara vb. ilişkin yönergeler eklenecek şekilde genişletilmesi gerekir.
Dahası, E-postalar'da, Kampanyalarda ve güncellenmesi gereken eski/eski bilgilerde epey bilgi eksik.
Katkıda bulunmak istediğim alan:
Kullanıcıların Mautic topluluğuyla doğrudan etkileşimde bulunduğu Slack kanallarındaki tartışmaları incelerken, Kampanyalar ve E-postaların Mautic'in çok önemli öğeleri olduğunu fark ettim. Sürüm 3 için Mautibox'ı kullanarak Kampanyalar ile ilgili dokümanları test ettim ve ciddi bir yenileme yapılması gerektiğini anladım. Bulduğum bazı sorunlar ve her biriyle ilgili teklifimiz:
- Mautic kullanıcısı, bir kampanya oluştururken çeşitli işlemler, kararlar ve koşullar arasından seçim yapabilir. Birçok işlem ve karara ait belgeler eksik olsa da kampanya koşullarıyla ilgili neredeyse hiçbir belge yok. Eksik bilgileri belirleyip son kullanıcı dokümanına eklememiz gerekir.
- Kampanyalar basit veya son derece karmaşık olabilir. Mevcut dokümanlar, ilk kez kampanya 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 başvurabilecekleri bazı kullanım alanlarını (basit ve karmaşık) belirlemeyi ve örnek iş akışları (adım adım öğreticiler veya son kullanıcı kılavuzunda konular ya da adım adım açıklamalı videolar şeklinde) 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 uygulanmalıdır. 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.
Kullanıcı arayüzüne göre, kampanyalara ek olarak e-postalara ilişkin dokümanları da test ettim. Üzerinde çalışmanızı ö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 bir doküman yoktur. Birkaç örnekle birlikte dinamik içeriğin ne yaptığı ve nasıl ayarlanacağıyla ilgili ayrıntıları ekleyin.
- Monitoring e-postaları için ayrı bir konu ekleyin. Bu, 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 bilgileri içerebilir. Ayrıca, izleme e-postalarıyla ilgili bilgileri buraya taşıyın.
- Bu dokümanlarda kişi yanıtları, geri dönme yönetimi, e-postanın sahibi olduğu (E-posta Ayarları) altında genel yapılandırma ayarları olduğu açıklanmamaktadır. Tüm E-posta ayarları bir şemsiye konu altında yer almalıdır. Ayrıca varsayılan sıklık kuralları ve e-posta listesinden çıkma ayarları gibi diğer birçok e-posta ayarı hiçbir şekilde belgelenmez. Hangi ayarların zorunlu veya isteğe bağlı olduğunu belirtin.
- Hemen çıkma yönetimi sayfasından Webhook'larla ilgili tüm bilgileri kaldırın ve Webhook'lar için ayrı bir konuya yerleştirin. Ardından buradan bu konuya bir bağlantı sağlayabiliriz.
Ayrıca: - Gösterge Tablosu konusunda, kullanılabilir widget'larla ilgili eksik bilgiler vardır. Kullanıcıların Mautic kaynaklarını analiz edip izlemesine yardımcı olan bu bilgiler önemlidir ve eklenmesi gerekir.
Boşlukları tespit etmek için belgenin tamamının takılması gerekir. Dokümanı kullanıcılarımız için daha ulaşılabilir hale getirmek için yenilememiz gerekiyor.
Bilgimin/deneyimimin bu proje için nasıl faydalı olmasını bekliyorum?
Geçtiğimiz ay en son 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 doldurabileceğimizi anlamak için diğer pazarlama otomasyonu araçlarının dokümanlarını araştırmak ve bunları Mautic son kullanıcı dokümanlarıyla karşılaştırmak için zaman harcadım. HTML dili, açık kaynaklı araçlar ve süreçlere aşina olmam ek bir avantaj. Şu anda kullanıcı deneyimi araştırmasıyla ilgili bir kursa devam ediyorum ve bu ilkeleri, daha kullanıcı odaklı dokümanlar oluşturmak için uygulayabilirim. 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 ustalığım var. 10 yıllık teknik yazarlık tecrübesi ve GSOD sayesinde benim için tamamen yeni olan bir kuruluşun projesini başarıyla tamamlama tecrübem sayesinde, Mautic belgelerine yaptığım katkının hakkını verebileceğimden eminim.