Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Mautik
- Penulis teknis:
- Lebih menyukai Kelvin
- Nama proyek:
- Basis pengetahuan
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Abstract
Basis pengetahuan adalah repositori terpusat tempat informasi disimpan, diatur, dan kemudian dibagikan. Saat digunakan secara eksternal, basis pengetahuan adalah tempat pengguna dapat mempelajari semua hal yang perlu mereka ketahui tentang produk atau layanan perusahaan, organisasi, dan industri. Sebaliknya, basis pengetahuan internal biasanya digunakan sebagai cara untuk memungkinkan komunitas/pengguna berkolaborasi dan mendistribusikan semua pengetahuan dan informasi perusahaan secara internal. Meskipun konten pusat informasi tertentu bervariasi berdasarkan banyak faktor, sebagian besar konten biasanya menyertakan informasi mengenai cara mulai menggunakan produk tertentu, mengoptimalkan penggunaan fitur lanjutan, dan mengatasi masalah atau masalah umum. Manfaat utama membuat dan menyajikan basis pengetahuan kepada audiens adalah Anda dapat memberikan informasi yang mendalam, instan, dan sesuai permintaan, kepada anggota/pengguna/komunitas audiens Anda tanpa perlu melakukannya secara individu.
Mautic Knowledgebase adalah tempat terpusat untuk tutorial, panduan cara kerja, dan praktik terbaik tentang topik yang terkait dengan Mautic - baik secara langsung (mis. cara melakukan sesuatu di Mautic) atau secara tidak langsung (mis. strategi pemasaran yang lebih umum).
Pada saat penulisan ini, Basis Pengetahuan Mautic masih cukup baru dan belum lengkap, dan komunitas Mautic ingin menggunakan project ini untuk meningkatkan caranya dalam menyediakan informasi yang mendalam dan sesuai permintaan ke dokumentasi pengguna agar pengguna akhir memiliki pengalaman yang lancar saat menggunakan Mautic. Mempelajari Mautic Knowledgebase cukup informatif, tetapi memerlukan tutorial dan panduan cara kerja yang diperbarui, serta pembuatan tutorial baru dan agar sesuai dengan versi Mautic 3x.
Kesan pertama saya saat membaca dokumentasi yang ada Saat ini, Mautic Knowledgebase tersedia di https://kb.mautic.org/. Beberapa tutorial dan panduan cara kerja serta topik praktik terbaik dalam dokumentasi bukanlah yang terbaru serta jarang atau tidak lengkap, dan juga tidak mencakup informasi tentang versi mautik saat ini.
Mengapa peningkatan yang Anda usulkan untuk satu/area saat ini yang ingin saya beri kontribusi? Peningkatan yang diusulkan adalah untuk meningkatkan dan memastikan efisiensi, konsistensi, dan ketenangan pikiran bagi setiap pengguna akhir. Kursus ini akan berisi tutorial tertulis dan panduan cara kerja serta praktik terbaik beserta gambar terkait, termasuk petunjuk dan penjelasan tentang cara menggunakan setiap fitur mautic, terbaru, mudah dinavigasi, dan mudah dipahami.
Analisis
Mautic Knowledgebase ditulis dalam CMS file datar Grav dan tema KLB4. Saya telah banyak meneliti cara untuk meningkatkan dokumentasi pusat informasi
Tujuan Proyek
- Tinjau pusat informasi.
- Perbarui tutorial dan panduan cara kerja sesuai dengan versi Mautic 3x.
- Buat referensi untuk Pusat Pengetahuan Komunitas Mautic yang baru dibuat
- Tulis serangkaian tutorial dan panduan cara kerja yang akan membantu pengguna Mautic menjadi lebih efektif dalam menyiapkan, mengonfigurasi, dan menggunakan aplikasi.
- Perbarui tutorial video agar sesuai dengan versi Mautic 3x.
- Hapus gambar dan informasi yang sudah tidak digunakan lagi.
- Tulis ulang pusat informasi agar lebih mudah dipahami.
- Memastikan implementasi panduan gaya/pola dokumentasi pengetahuanbase yang tepat
Rentang waktu
Sebelum 1 Agustus
- Terus memberikan kontribusi kepada organisasi.
- Pelajari lebih lanjut dokumentasi pusat informasi dan versi Mautic saat ini.
- Mempelajari teknik-teknik baru dan keterampilan menulis teknis yang akan berguna saat menerapkan proyek ini.
Ikatan komunitas (1 Agustus - 1 September)
- Menyiapkan saluran dan waktu komunikasi (karena perbedaan waktu)
- Sempurnakan tujuan saya dan tetapkan ekspektasi dari kedua sisi
- Pelajari komunitas dan produk lebih lanjut
- Membahas struktur dokumentasi yang diusulkan dengan mentor dan anggota organisasi lainnya.
- Menyelesaikan fitur yang diusulkan dan modifikasi lain yang perlu dilakukan pada dokumentasi yang ada.
Periode Dokumentasi
- Minggu ke-1 (2 September - 22 November)
- Selama periode ini, saya akan bekerja sama langsung dengan mentor untuk :
- Tinjau pusat informasi.
- Perbarui tutorial dan panduan cara kerja sesuai dengan versi Mautic 3x.
- Buat referensi untuk Pusat Pengetahuan Komunitas Mautic yang baru dibuat
- Tulis serangkaian tutorial dan panduan cara kerja yang akan membantu pengguna Mautic menjadi lebih efektif dalam menyiapkan, mengonfigurasi, dan menggunakan aplikasi.
- Perbarui tutorial video agar sesuai dengan versi Mautic 3x.
- Hapus gambar dan informasi yang sudah tidak digunakan lagi.
- Tulis ulang pusat informasi agar lebih mudah dipahami.
- Pastikan penerapan panduan gaya/pola dokumentasi pengetahuan dasar yang tepat.
- Mempertimbangkan ritme rilis karena tim developer akan sibuk dengan rilis fitur minor
Evaluasi Proyek (25 November - 29 November 2019)
- Mengirimkan laporan proyek dan evaluasi oleh mentor saya
- Tulis dan kirimkan laporan pengalaman saya sebagai peserta dalam Season Dokumen.