Project Mautic

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.

Ringkasan proyek

Organisasi open source:
Mautik
Penulis teknis:
Favour Kelvin
Nama proyek:
Knowledgebase
Durasi project:
Durasi standar (3 bulan)

Project description

Abstrak

Pustaka informasi adalah repositori terpusat tempat informasi disimpan, diatur, lalu dibagikan. Jika digunakan secara eksternal, pusat informasi adalah tempat pengguna dapat mempelajari apa pun yang perlu mereka ketahui tentang produk atau layanan, organisasi, dan industri perusahaan. Di sisi lain, pusat informasi internal biasanya digunakan sebagai cara untuk memungkinkan komunitas/pengguna berkolaborasi dan mendistribusikan semua pengetahuan dan informasi perusahaan secara internal. Meskipun konten pustaka informasi tertentu bervariasi berdasarkan berbagai faktor, sebagian besar biasanya menyertakan informasi tentang cara mulai menggunakan produk tertentu, mendapatkan lebih banyak manfaat dari fitur lanjutan, dan mengatasi masalah atau masalah umum. Manfaat utama dengan membuat dan menyajikan basis pengetahuan kepada audiens adalah Anda dapat memberikan informasi yang mendalam, instan, dan sesuai permintaan, serta jawaban kepada anggota audiens/pengguna/komunitas tanpa perlu melakukannya satu per satu.

Pustaka Referensi Mautic adalah repositori pusat untuk tutorial, panduan cara, dan praktik terbaik tentang topik yang terkait dengan Mautic - baik secara langsung (misalnya, cara melakukan sesuatu di Mautic) maupun tidak langsung (misalnya, strategi pemasaran yang lebih umum).

Pada saat penulisan ini, Knowledgebase Mautic masih cukup baru dan belum lengkap. Komunitas Mautic ingin menggunakan project ini untuk meningkatkan cara menyediakan informasi mendalam dan on demand ke dokumentasi pengguna agar pengguna akhir dapat memiliki pengalaman yang lancar saat menggunakan Mautic. Menjelajahi Pusat Pengetahuan Mautic cukup informatif, tetapi memerlukan tutorial dan panduan cara yang diperbarui, serta pembuatan tutorial dan panduan cara baru agar sesuai dengan versi Mautic 3x.

Kesan pertama saya saat membaca dokumentasi yang ada Saat ini, Knowledgebase Mautic tersedia di https://kb.mautic.org/. Beberapa tutorial, panduan cara kerja, dan topik praktik terbaik dalam dokumentasi tidak mutakhir dan jarang atau tidak lengkap, serta tidak mencakup informasi tentang versi mautic terbaru.

Mengapa usulan perbaikan Anda atas area/area yang saat ini ingin saya beri kontribusi? Peningkatan yang diusulkan akan meningkatkan dan memastikan efisiensi, konsistensi, dan ketenangan bagi pengguna akhir. Panduan ini akan berisi tutorial tertulis dan panduan cara serta praktik terbaik dan gambar terkait, serta menyertakan petunjuk dan penjelasan tentang cara menggunakan setiap fitur Mautic, yang terbaru, mudah dinavigasi, dan mudah dipahami.

Analisis

Pustaka Referensi Mautic ditulis dalam CMS file datar Grav dan tema KLB4. Saya banyak meneliti cara untuk meningkatkan kualitas dokumentasi pusat informasi

Sasaran Project

  • Tinjau pusat informasi.
  • Memperbarui tutorial dan panduan cara sesuai dengan versi Mautic 3x.
  • Membuat referensi untuk Pusat Informasi Komunitas Mautic yang baru dibuat
  • Tulis serangkaian tutorial dan panduan cara yang akan membantu pengguna Mautic menjadi lebih efektif dalam menyiapkan, mengonfigurasi, dan menggunakan aplikasi.
  • Memperbarui tutorial video agar sesuai dengan versi Mautic 3x.
  • Hapus gambar dan informasi yang sudah tidak berlaku.
  • Tulis ulang pusat informasi agar lebih mudah dipahami.
  • Memastikan penerapan panduan gaya/pola dokumentasi knowledge base yang tepat

Linimasa

Sebelum 1 Agustus

  • Terus berkontribusi pada organisasi.
  • Memahami lebih lanjut dokumentasi knowledgebase dan versi Mautic saat ini.
  • Pelajari teknik baru dan keterampilan menulis teknis yang akan berguna saat menerapkan project.

Pengikatan komunitas (1 Agustus - 1 September)

  • Menyiapkan saluran komunikasi dan waktu (karena perbedaan waktu)
  • Mempertajam sasaran dan menetapkan ekspektasi di kedua belah pihak
  • Pelajari komunitas dan produk lebih lanjut
  • Membahas struktur dokumentasi yang diusulkan dengan mentor dan anggota lain dari organisasi.
  • Selesaikan 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 langsung dengan mentor saya untuk :
  • Tinjau pusat informasi.
  • Memperbarui tutorial dan panduan cara sesuai dengan versi Mautic 3x.
  • Membuat referensi untuk Pusat Informasi Komunitas Mautic yang baru dibuat
  • Tulis serangkaian tutorial dan panduan cara yang akan membantu pengguna Mautic menjadi lebih efektif dalam menyiapkan, mengonfigurasi, dan menggunakan aplikasi.
  • Memperbarui tutorial video agar sesuai dengan versi Mautic 3x.
  • Hapus gambar dan informasi yang sudah tidak berlaku.
  • Tulis ulang pusat informasi agar lebih mudah dipahami.
  • Pastikan penerapan panduan/pola gaya dalam dokumentasi basis pengetahuan dengan benar.
  • Mempertimbangkan ritme rilis karena tim developer akan sibuk dengan rilis fitur minor

Evaluasi Project (25 November - 29 November 2019)

  • Mengirimkan laporan dan evaluasi project oleh mentor saya
  • Menulis dan mengirimkan laporan tentang pengalaman saya sebagai peserta dalam Season of Docs.