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:
- Kelvin'i Öne Çıkar
- Proje adı:
- Bilgi tabanı
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Özet
Bilgi tabanı, bilgilerin depolandığı, düzenlendiği ve ardından paylaşıldığı merkezi bir depodur. Bilgi tabanı, harici olarak kullanıldığında kullanıcıların bir şirketin ürünleri veya hizmetleri, kuruluşu ve sektörü hakkında bilmek istedikleri her şeyi öğrenmek için kullanabileceği yerdir. Öte yandan, dahili bilgi tabanı genellikle topluluğun/kullanıcıların ortak çalışmasına ve tüm şirket bilgi ve bilgilerini kurum içinde dağıtmasına olanak tanımak için kullanılır. Belirli bilgi tabanlarının içeriği birçok faktöre bağlı olarak değişiklik gösterse de çoğu genellikle belirli ürünleri kullanmaya başlama, gelişmiş özelliklerden daha fazla yararlanma ve sık karşılaşılan sorunların veya sorunların üstesinden gelme ile ilgili bilgiler içerir. Bir bilgi tabanı oluşturup bunları kitlenize sunmanın temel faydası, bireysel olarak yapmanıza gerek kalmadan ayrıntılı, anlık, talebe bağlı bilgiler ve kitle üyelerinize/kullanıcılarınıza/topluluğunuza yanıt verebilmenizi sağlamasıdır.
Mautic Knowledgebase; doğrudan (ör. Mautic'te işlerin nasıl yapılacağı) veya dolaylı (ör. daha genel pazarlama stratejileri) olarak Mautic'le ilgili konularda eğiticiler, "Nasıl Yapılır?" kılavuzları ve en iyi uygulamalar için merkezi bir veri havuzudur.
Bu yazı yazıldığında, Mautic Bilgi Tabanı epey yeni ve eksikti. Mautic topluluğu, bu projeyi, son kullanıcıların Mautic'i kullanırken sorunsuz bir deneyim yaşamalarını sağlamak amacıyla kullanıcı dokümanlarına ayrıntılı ve isteğe bağlı bilgiler sağlama yöntemini iyileştirmek için kullanmak istiyor. Mautic Bilgi Tabanı'nı incelemek oldukça bilgilendiriciydi, ancak Mautic 3x sürümüyle eşleştirmek için yeni eğiticilerin ve nasıl yapılır kılavuzlarının da oluşturulması gerekiyordu.
Mevcut belgeleri incelerken edindiğim ilk izlenimler Mautic Bilgi Bankası şu an için https://kb.mautic.org/ adresinde kullanıma sunulmuştur. Belgelerdeki bazı eğiticiler, "Nasıl Yapılır?" kılavuzları ve en iyi uygulama konuları güncel değildir, az veya eksiktir ve ayrıca mautic'in geçerli sürümüyle ilgili bilgileri de kapsamaz.
Katkıda bulunmak istediğim mevcut alana/alanlara kıyasla iyileştirmenizin önermenizin nedeni nedir? Önerilen iyileştirme, herhangi bir son kullanıcının verimliliğini, tutarlılığını ve iç huzurunu iyileştirip güvence altına almak olacaktır. Bu kılavuzda yazılı eğitimler, "Nasıl Yapılır?" kılavuzları, en iyi uygulamalar ve ilgili resimler yer alacak. Ayrıca, mautic'in her bir özelliğinin nasıl kullanılacağına dair talimatlar ve açıklamalar da içerecek. Bu bilgiler güncel, kolay gezinilen ve anlaşılabilir olmalıdır.
Analiz
Mautic Bilgi Tabanı, Grav düz dosya İYS'si ve KLB4 temasıyla yazılmıştır. Bilgi tabanı belgelerini geliştirmenin yolları üzerine çok araştırdım.
Proje Hedefleri
- Bilgi tabanını inceleyin.
- Eğiticileri ve "Nasıl Yapılır?" kılavuzlarını, Mautic 3x sürümüne uyacak şekilde güncelleyin.
- Yeni oluşturulan Mautic Community Bilgi Tabanı için kaynaklar oluşturun
- Mautic kullanıcılarının uygulamayı kurma, yapılandırma ve kullanma konusunda daha etkili olmasına yardımcı olacak bir dizi "Nasıl yapılır?" eğiticisi ve kılavuz hazırlayın.
- Eğitim videosunu Mautic 3x sürümüne uyacak şekilde güncelleyin.
- Eski resimleri ve bilgileri kaldırın.
- Bilgi tabanını daha kolay anlaşılacak şekilde yeniden yazın.
- Bilgi tabanı dokümanlarının stil kılavuzu/kalıpının doğru bir şekilde uygulandığından emin olmak
Zaman çizelgesi
1 Ağustos'tan önce
- Kuruluşa katkıda bulunmaya devam edin.
- Bilgi tabanı belgeleri ve Mautic'in mevcut sürümü hakkında daha fazla bilgi edinin.
- Projeyi uygularken faydalı olacak yeni teknikleri ve teknik yazma becerilerini öğrenme.
Topluluk bağları (1 Ağustos - 1 Eylül)
- İletişim kanalı ve saat oluşturun (saat farkı nedeniyle)
- Hedeflerimi hassaslaştırmak ve her iki tarafta da beklentilerimi belirlemek
- Topluluk ve ürün hakkında daha fazla bilgi edinin
- Önerilen belge yapısını mentorlar ve kuruluşun diğer üyeleriyle tartışma.
- Önerilen özellikleri ve mevcut dokümanlarda yapılması gereken diğer değişiklikleri tamamlayın.
Belgeleme Süresi
- 1. Hafta (2 Eylül - 22 Kasım)
- Bu dönemlerde aşağıdaki konularda doğrudan mentorlarımla birlikte çalışacağım :
- Bilgi tabanını inceleyin.
- Eğiticileri ve "Nasıl Yapılır?" kılavuzlarını, Mautic 3x sürümüne uyacak şekilde güncelleyin.
- Yeni oluşturulan Mautic Community Bilgi Tabanı için kaynaklar oluşturun
- Mautic kullanıcılarının uygulamayı kurma, yapılandırma ve kullanma konusunda daha etkili olmasına yardımcı olacak bir dizi "Nasıl yapılır?" eğiticisi ve kılavuz hazırlayın.
- Eğitim videosunu Mautic 3x sürümüne uyacak şekilde güncelleyin.
- Eski resimleri ve bilgileri kaldırın.
- Bilgi tabanını daha kolay anlaşılacak şekilde yeniden yazın.
- Bilgi tabanı dokümanlarının stil kılavuzu/kalıpının doğru uygulandığından emin olun.
- Geliştirici ekibi küçük özellik sürümleriyle meşgul olduğundan sürüm yayınlama sıklığını dikkate alma
Proje Değerlendirmesi (25 Kasım - 29 Kasım 2019)
- Proje raporu ve mentorlarım tarafından yapılan değerlendirmeleri göndermek
- Dokümanlar Mevsimi'ndeki bir katılımcı olarak deneyimle ilgili bir rapor yazma ve gönderme.