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:
- Favor Kelvin
- Proje adı:
- Knowledgebase
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Soyut
Bilgi bankası, bilgilerin depolandığı, düzenlendiği ve ardından paylaşıldığı merkezi bir depodur. Harici olarak kullanıldığında bilgi bankası, kullanıcıların bir şirketin ürün veya hizmetleri, kuruluşu ve sektörü hakkında bilmeleri gereken her şeyi öğrenebilecekleri bir yerdir. Diğer yandan, dahili bir bilgi bankası genellikle topluluğun/kullanıcılarının ortak çalışmasına ve tüm şirket bilgilerini ve bilgilerini dahili olarak dağıtmasına olanak tanıyan bir yöntem olarak kullanılır. Belirli bilgi tabanlarının içeriği pek çok etkene bağlı olarak değişiklik gösterse de çoğu zaman, belirli ürünleri kullanmaya başlama, ileri seviye özelliklerden daha fazla yararlanma ve yaygın sorunların veya sorunların üstesinden gelmeyle ilgili bilgiler bulunur. Kitlenize bir bilgi bankası oluşturup sunmanın en önemli avantajı, bunu tek tek yapmak zorunda kalmadan kitle üyelerinize/kullanıcılarınıza/topluluğunuza ayrıntılı, anında ve isteğe bağlı bilgi ve yanıtlar sunmanıza olanak tanımasıdır.
Mautic Bilgi Bankası, doğrudan (ör. Mautic'te nasıl yapılır) veya dolaylı olarak (ör. daha genel pazarlama stratejileri) Mautic ile ilgili konularda eğitici içeriklerin, "Nasıl Yapılır?" kılavuzlarının ve en iyi uygulamaların yer aldığı merkezi bir veri deposudur.
Bu makalenin yazıldığı sırada Mautic Bilgi Bankası oldukça yeni ve eksik. Mautic topluluğu, son kullanıcıların Mautic'i kullanırken sorunsuz bir deneyim yaşamasını sağlamak için kullanıcı dokümanlarına derinlemesine ve isteğe bağlı bilgi sağlama yöntemini iyileştirmek amacıyla bu projeyi kullanmak istiyor. Mautic Bilgi Bankası'nı incelemek oldukça bilgilendiriciydi ancak Mautic 3x sürümüne uygun olması için güncellenmiş eğitici içerikler ve kullanım kılavuzlarının yanı sıra yeni içeriklerin oluşturulması gerekiyordu.
Mevcut dokümanları incelediğimde ilk izlenimlerim Mautic Bilgi Bankası şu anda https://kb.mautic.org/ adresinde mevcuttur. Dokümanlar bölümündeki eğitici içerikler, kullanım kılavuzları ve en iyi uygulamalar konularının bazıları güncel değil, eksik veya yetersiz. Ayrıca, Mautic'in mevcut sürümüyle ilgili bilgiler de yer almıyor.
Önerdiğiniz iyileştirme, katkıda bulunmak istediğim mevcut alana/alanlara göre neden daha uygun? Önerilen iyileştirme, tüm son kullanıcılar için verimliliği, tutarlılığı ve gönül rahatlığını iyileştirmeyi ve sağlamayı amaçlamaktadır. Yazılı eğiticiler, "Nasıl Yapılır?" kılavuzları, en iyi uygulamalar ve bunlarla ilişkili görsellerin yanı sıra mautic'in her bir özelliğinin nasıl kullanılacağına ilişkin talimatlar ve açıklamalar, güncel, gezinmesi kolay ve anlaşılır bilgiler içerecek.
Analiz
Mautic Bilgi Bankası, Grav düz dosya içerik yönetim sistemi ve KLB4 temasıyla yazılmıştır. Bilgi bankası dokümanlarını iyileştirmenin yolları hakkında çok fazla araştırma yaptım
Proje Hedefleri
- Bilgi bankasını inceleyin.
- Eğitimleri ve nasıl yapılır kılavuzlarını Mautic 3x sürümüne uygun şekilde güncelleyin.
- Yeni oluşturulan Mautic Topluluğu Bilgi Bankası için kaynaklar oluşturun
- Mautic kullanıcılarının uygulamayı kurma, yapılandırma ve kullanma konusunda daha verimli olmasına yardımcı olacak bir dizi "nasıl yapılır" eğiticisi ve kılavuz hazırlayın.
- Video eğitimlerini Mautic 3x sürümüne uygun olacak şekilde güncelleyin.
- Eski resimleri ve bilgileri kaldırın.
- Bilgi bankasını daha kolay anlaşılır hale getirmek için yeniden yazın.
- Bilgi bankası dokümanlarıyla ilgili stil kılavuzunun/deseninin doğru şekilde uygulandığından emin olun
Zaman çizelgesi
1 Ağustos'tan önce
- Kuruluşa katkıda bulunmaya devam etmek.
- Bilgi bankası dokümanlarını ve Mautic'in mevcut sürümünü daha iyi öğrenin.
- Projeyi uygularken faydalı yeni teknikler ve teknik yazma becerileri öğrenme.
Topluluk bağları (1 Ağustos - 1 Eylül)
- İletişim kanalı ve saati ayarlama (saat farkı nedeniyle)
- Hedeflerimi hassaslaştır ve her iki taraftan da beklenti oluştur
- Topluluk ve ürün hakkında daha fazla bilgi
- Önerilen doküman yapısı hakkında mentorlarla ve kuruluşun diğer üyeleriyle görüşme.
- Teklif edilen özellikleri ve mevcut belgelerde yapılması gereken diğer değişiklikleri sonlandırın.
Belgeleme Süresi
- 1. Hafta (2 Eylül - 22 Kasım)
- Bu süre zarfında doğrudan mentorlarımla çalışarak şunları yapacağım :
- Bilgi bankasını inceleyin.
- Eğitimleri ve nasıl yapılır kılavuzlarını Mautic 3x sürümüne uygun şekilde güncelleyin.
- Yeni oluşturulan Mautic Topluluğu Bilgi Bankası için kaynaklar oluşturun
- Mautic kullanıcılarının uygulamayı kurma, yapılandırma ve kullanma konusunda daha verimli olmasına yardımcı olacak bir dizi "nasıl yapılır" eğiticisi ve kılavuz hazırlayın.
- Video eğitimlerini Mautic 3x sürümüne uygun olacak şekilde güncelleyin.
- Eski resimleri ve bilgileri kaldırın.
- Bilgi tabanını daha kolay anlaşılır hale getirecek şekilde yeniden yazın.
- Bilgi bankası dokümanlarının stil kılavuzunun/deseninin doğru şekilde uygulandığından emin olun.
- Geliştirici ekibi küçük özellik sürümleriyle meşgul olacağından sürümün ritmi dikkate alınmalıdır.
Proje Değerlendirmesi (25 - 29 Kasım 2019)
- Proje raporu ve danışmanlarımın değerlendirmesini gönderme
- Dokümanlar Sezonu'na katılan bir katılımcı olarak deneyimimi anlatan bir rapor yazıp gönderme.