Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- Mautic
- Teknik yazar:
- Swati Thacker
- Projenin adı:
- Mautic için son kullanıcı dokümanlarını inceleyip güncelleyin
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Mevcut belgeleri incelerken ilk izlenimlerim:
Şu anda dokümanlar uzun, birçok yerde gereksiz, eksik ve düzensiz. Bu durum, kullanıcıların aradıkları bilgileri bulmasını zorlaştırabilir.
İlk kez kullanıcı olarak, Mautic'in farklı unsurlarının (ör. Kampanyalar, öğeler, mesajlar, kategoriler vb.) işletme ihtiyacını karşılamak için nasıl bir araya geldiğini anlayamadım. Her Mautic öğesini 2-3 satırda açıklayan üst düzey bir kavramsal konu öneririm. Bu konu, bu öğelerin her biri için çeşitli ayrıntılı görev konularına bağlantı verebilir.
Katkı sunma kılavuzu, forumların, Slack kanallarının ve git depolarının bağlantılarını sağlayarak sorun açma, yeni içerik/fikir önerme, hata/sorun/güvenlik açığı bildirme gibi daha fazla bilgiyi içerecek şekilde genişletilebilir. Ayrıca stil kılavuzunda standart yazım kuralları, resimler, tablolar vb. için yönergeler eklenmelidir.
Dahası, E-postalar'da, Kampanyalarda ve güncellenmesi gereken eski/eski bilgilerde oldukça fazla eksik bilgi var.
Katkıda bulunmak istediğim alan:
Kullanıcıların doğrudan Mautic topluluğuyla etkileşime geçtiği Slack kanallarındaki tartışmaları incelerken kampanyaların ve e-postaların Mautic'in önemli unsurları olduğunu fark ettim. Mautibox sürüm 3'ü kullanarak Kampanyalar ile ilgili dokümanları test ettim ve büyük ölçüde yenilenmesi gerektiğini gördüm. Bulduğum bazı sorunlar ve her biri için önerim aşağıda verilmiştir:
- Mautic kullanıcıları kampanya oluştururken çeşitli işlemler, kararlar ve koşullar arasından seçim yapabilir. Birçok eylem ve kararla ilgili belgeler eksik ama kampanya koşullarıyla ilgili neredeyse bir belge yok. Eksik bilgileri belirleyip son kullanıcı dokümanına eklememiz gerekiyor.
- Kampanyalar basit veya son derece karmaşık olabilir. Mevcut dokümanlar, kampanya oluşturmaya ilk kez başlayan kullanıcılara fazla değer katmıyor. Yeni bir kullanıcının kendi kampanyalarını oluşturmaya başlamadan önce, bazı kullanım alanlarını (hem basit hem de karmaşık) tanımlamayı ve örnek iş akışları oluşturmayı (adım adım açıklamalı eğitimler veya son kullanıcı kılavuzundaki konular ya da adım adım açıklamalı videolar biçiminde) oluşturmayı öneriyorum.
- Bilgilerin bu bölümde daha düzenli ve düzenli bir şekilde sunulması gerekir. Kullanılabilirliği artırmak için görev ve kavram tabanlı yaklaşım takip edilmelidir. Konularda, işlemler, kararlar ve koşullarla ilgili bilgileri sunmak için tablolar kullanılabilir. "Tarih tetikleyicileri kullanma" konusu biraz alakasız. Koşullar bölümünün altına yerleştirilebilir.
Kampanyalar'ın yanı sıra, e-postalara ilişkin dokümanları da kullanıcı arayüzüyle karşılaştırarak test ettim. Şunları yapmanızı öneririm:
- E-postalar için dinamik içerik, özel kod e-posta şablonlarında (hem Şablonlar e-postaları hem de Segmentler e-postaları için) kullanılabilir ancak şu anda bu özellikle ilgili doküman yoktur. Dinamik içeriğin işlevi ve nasıl ayarlanacağı hakkında ayrıntılı bilgi ve birkaç örnek ekleyin.
- E-postaları izleme için ayrı bir konu ekleyin. Kontrol panelinde bulunan e-posta widget'larının kullanımı ve e-postalarla ilgili metrikleri ve etkinlikleri izlemek için nasıl kullanılabileceği hakkında bilgiler bu kapsamda yer alabilir. Ayrıca, e-postaları takip etme hakkındaki bilgileri de buraya taşıyın.
- Dokümanda, iletişim yanıtları, geri gönderme yönetimi ve gönderenin sahip olması gibi ayarların E-posta Ayarları altında yapılandırılabilir genel yapılandırma ayarları olduğu net bir şekilde belirtilmiyor. Tüm e-posta ayarları bir üst 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ç belgelenmemiştir. Hangi ayarların zorunlu veya isteğe bağlı olduğunu belirtin.
- İptal yönetimi sayfasından Webhook'larla ilgili tüm bilgileri kaldırın ve Webhook'lar için ayrı bir konuya yerleştirin. Sonrasında buradan bu konunun bağlantısını paylaşabiliriz.
Ayrıca: - Kontrol paneli konusunda, mevcut widget'lar hakkında eksik bilgiler var. Bu bilgiler önemlidir ve kullanıcıların Mautic kaynaklarını analiz edip izlemesine yardımcı olduğu için eklenmesi gerekir.
Boşlukları tespit etmek için dokümanların tamamının yakalanması gerekir. Dokümanı kullanıcılarımız için daha erişilebilir hale getirmek üzere yenilememiz gerekiyor.
Bilgimin/deneyimimin bu projeye nasıl fayda sağlayacağını düşünüyorsunuz?
Son bir ay içinde en son Mautic 3.0 sürümü için destek ekleme de dahil olmak üzere Mautic dokümanlarında çeşitli sorunlar üzerinde çalıştıktan sonra, son kullanıcı dokümanlarının yapısı hakkında bilgi edindim ve dokümanlardaki boşlukları tespit ettim. Dokümanlarımızdaki boşlukları nasıl doldurabileceğimizi anlamak için diğer pazarlama otomasyonu araçlarının dokümanlarını araştırıp bunları Mautic son kullanıcı dokümanlarıyla karşılaştırdım. HTML dili, açık kaynak araçları ve süreçler hakkında bilgi sahibi olmam da bir avantaj. Şu anda kullanıcı deneyimi araştırması kursuna devam ediyorum ve bu ilkeleri daha kullanıcı odaklı dokümanlar oluşturmak için uygulayabilirim. Ayrıca, bilgi mimarisi konusundaki deneyimim sayesinde içeriği düzenleyebilir ve dokümanlarımızı kullanıcı hedefleriyle uyumlu hale getirmek için fikirler önerebilirim. Ayrıca, yeni teknik alanlar hakkındaki bilgimi genişletme konusunda da iyiyim. 10 yıllık teknik yazı deneyimim ve tamamen yeni bir teknik alanda bir kuruluş için projeyi başarıyla tamamladığım önceki GSOD deneyimim sayesinde, Mautic dokümanlarına katkıda bulunmaktan memnuniyet duyacağım.