Project Mautic

Halaman ini berisi detail proyek penulisan teknis yang diterima untuk Google Season of 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 di mana informasi disimpan, diatur, dan kemudian dibagikan. Saat digunakan secara eksternal, pusat informasi adalah tempat pengguna dapat mempelajari semua hal yang perlu mereka ketahui tentang produk atau layanan perusahaan, organisasi, dan industri. Sebaliknya, basis pengetahuan internal, di sisi lain, biasanya digunakan sebagai cara untuk memungkinkan komunitas/pengguna untuk berkolaborasi dan mendistribusikan semua pengetahuan dan informasi perusahaan secara internal. Meskipun konten pusat informasi tertentu bervariasi berdasarkan banyak faktor, umumnya mencakup informasi tentang cara mulai menggunakan produk tertentu, memanfaatkan lebih banyak fitur lanjutan, dan mengatasi masalah atau masalah umum. Manfaat utama dari membuat dan menyajikan pusat informasi kepada audiens adalah memungkinkan Anda memberikan informasi yang mendalam, instan, dan on demand, serta jawaban kepada anggota/pengguna/komunitas audiens Anda tanpa perlu melakukannya sendiri.

Mautic Knowledgebase adalah repositori pusat untuk tutorial, panduan cara kerja, dan praktik terbaik tentang topik yang terkait dengan Mautic - baik secara langsung (misalnya, cara melakukan berbagai hal di Mautic) atau secara tidak langsung (mis. strategi pemasaran yang lebih umum).

Pada saat penulisan ini, Basis Pengetahuan Mautic masih cukup baru dan tidak lengkap dan komunitas Mautic ingin menggunakan proyek ini untuk meningkatkan cara menyediakan informasi yang mendalam dan sesuai permintaan kepada dokumentasi pengguna agar pengguna akhir mendapatkan pengalaman yang mulus saat menggunakan Mautic. Mempelajari Mautic Knowledgebase cukup informatif tetapi memerlukan tutorial dan panduan cara kerja yang diperbarui serta pembuatan yang baru serta agar sesuai dengan versi Mautic 3x.

Kesan pertama saya saat melihat 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 tidak diperbarui dan jarang atau tidak lengkap, serta tidak mencakup informasi tentang versi mautic saat ini.

Mengapa peningkatan yang Anda usulkan terhadap salah satu/area tempat saya ingin berkontribusi? Peningkatan yang diusulkan adalah untuk meningkatkan dan memastikan efisiensi, konsistensi, dan ketenangan pikiran bagi setiap pengguna akhir. Dokumen ini akan berisi tutorial tertulis dan panduan cara kerja serta praktik terbaik beserta gambar terkait, termasuk petunjuk dan penjelasan tentang cara menggunakan setiap fitur mautik, terbaru, mudah dinavigasi, dan dapat dipahami.

Analisis

Mautic Knowledgebase ditulis dalam CMS file datar Grav dan tema KLB4. Saya banyak meneliti cara untuk meningkatkan dokumentasi berbasis pengetahuan

Tujuan Proyek

  • Tinjau basis pengetahuan.
  • Perbarui tutorial dan panduan cara kerja sesuai dengan versi Mautic 3x.
  • Buat referensi untuk Basis Pengetahuan Komunitas Mautic yang baru dibuat
  • Tulis serangkaian tutorial dan panduan cara kerja yang akan membantu pengguna Mautic secara lebih efektif dalam menyiapkan, mengonfigurasi, dan menggunakan aplikasi.
  • Perbarui video tutorial agar sesuai dengan versi Mautic 3x.
  • Hapus gambar dan informasi yang sudah tidak berlaku.
  • Menulis ulang pusat informasi agar lebih mudah dipahami.
  • Memastikan penerapan yang tepat terhadap panduan gaya/pola dokumentasi basis pengetahuan

Linimasa

Sebelum 1 Agustus

  • Terus berikan kontribusi kepada organisasi.
  • Pelajari lebih lanjut dokumentasi basis pengetahuan dan versi Mautic saat ini.
  • Mempelajari 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 di 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 saya untuk :
  • Tinjau basis pengetahuan.
  • Perbarui tutorial dan panduan cara kerja sesuai dengan versi Mautic 3x.
  • Buat referensi untuk Basis Pengetahuan Komunitas Mautic yang baru dibuat
  • Tulis serangkaian tutorial dan panduan cara kerja yang akan membantu pengguna Mautic secara lebih efektif dalam menyiapkan, mengonfigurasi, dan menggunakan aplikasi.
  • Perbarui video tutorial agar sesuai dengan versi Mautic 3x.
  • Hapus gambar dan informasi yang sudah tidak berlaku.
  • Menulis ulang pusat informasi agar lebih mudah dipahami.
  • Pastikan penerapan yang tepat terhadap panduan gaya/pola dokumentasi basis pengetahuan.
  • Mempertimbangkan ritme rilis karena tim developer akan sibuk dengan rilis fitur minor

Evaluasi Proyek (25 - 29 November 2019)

  • Mengirimkan laporan proyek dan evaluasi oleh mentor saya
  • Tulis dan kirim laporan tentang pengalaman saya sebagai peserta dalam Season Dokumen.