Halaman ini diterjemahkan oleh Cloud Translation API.

Project Mautic

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

Ringkasan project

Organisasi open source:: Mautik
Penulis teknis:: Swati Thacker
Nama project:: Meninjau dan memperbarui dokumentasi Pengguna Akhir untuk Mautic
Durasi project:: Durasi standar (3 bulan)

Project description

Kesan pertama saya saat membaca dokumentasi yang ada:

Saat ini, dokumentasi tersebut panjang, redundan di banyak tempat, tidak lengkap, dan tidak teratur sehingga mungkin menyulitkan pengguna untuk menemukan informasi yang mereka cari.

Sebagai pengguna pertama kali, saya tidak dapat memahami bagaimana berbagai elemen Mautic seperti Kampanye, aset, pesan, kategori, dll. cocok bersama untuk memenuhi kebutuhan bisnis. Saya mengusulkan untuk memiliki topik konseptual tingkat tinggi yang menjelaskan setiap elemen Mautic dalam 2-3 baris. Topik ini kemudian dapat ditautkan ke berbagai topik tugas mendetail untuk setiap elemen tersebut.

Panduan kontribusi dapat diperluas untuk menyertakan informasi selengkapnya seperti, cara membuka masalah, cara menyarankan konten/ide baru, melaporkan bug/masalah/kerentanan keamanan, dll. dengan memberikan link ke forum, saluran Slack, dan repositori git. Selain itu, panduan gaya perlu diperluas untuk menambahkan konvensi tipografi standar, panduan untuk gambar, tabel, dll.

Selain itu, ada cukup banyak informasi yang tidak lengkap di Email, Kampanye, dan informasi lama/usang yang perlu diperbarui.

Area yang ingin saya dukung:

Saat membaca diskusi di saluran Slack tempat pengguna berinteraksi langsung dengan komunitas Mautic, saya menyadari bahwa Kampanye dan Email adalah elemen penting dari Mautic. Dengan menggunakan Mautibox untuk versi 3, saya menguji dokumentasi di Kampanye dan menemukan bahwa dokumentasi tersebut perlu diubah secara menyeluruh. Berikut beberapa masalah yang saya temukan dan proposal saya untuk setiap masalah:

Pengguna Mautic dapat memilih dari berbagai tindakan, keputusan, dan kondisi saat membuat kampanye. Dokumentasi tidak ada untuk banyak tindakan dan keputusan, sementara hampir tidak ada dokumentasi untuk kondisi kampanye. Kita perlu mengidentifikasi dan menambahkan informasi yang tidak ada ke dokumen pengguna akhir.
Kampanye dapat bersifat sederhana atau sangat kompleks. Dokumentasi saat ini tidak memberikan banyak nilai bagi pengguna yang membuat kampanye untuk pertama kalinya. Saya mengusulkan untuk mengidentifikasi beberapa kasus penggunaan (baik sederhana maupun kompleks) dan membuat contoh alur kerja (baik dalam bentuk tutorial langkah demi langkah, atau topik dalam panduan pengguna akhir atau video panduan) yang dapat dijadikan rujukan oleh pengguna pemula sebelum mereka mulai membuat kampanye sendiri.
Informasi perlu disajikan dengan cara yang lebih terorganisir dan teratur di bagian ini. Pendekatan berbasis tugas dan konsep harus diikuti untuk meningkatkan {i>usability <i}(kegunaan). Topik dapat menggunakan tabel untuk menyajikan informasi tentang tindakan, keputusan, dan kondisi. Topik 'Menggunakan pemicu tanggal' terasa sedikit tidak sesuai. Ini dapat disusun bertingkat di bagian Kondisi.

Selain Kampanye, saya juga menguji dokumentasi untuk Email terhadap UI. Berikut ini yang saya sarankan untuk dikerjakan:

Konten Dinamis untuk Email tersedia untuk template email kode kustom (baik untuk email Template maupun email Segmen), tetapi saat ini tidak ada dokumentasi untuknya. Tambahkan detail tentang fungsi konten dinamis, dan cara menyiapkannya, beserta beberapa contoh.
Menambahkan topik terpisah untuk email Monitoring. Hal ini dapat mencakup informasi tentang penggunaan widget email yang tersedia di dasbor dan cara widget tersebut dapat digunakan untuk melacak metrik dan aktivitas terkait email. Selain itu, pindahkan info tentang pelacakan email ke sini.
Dokumentasi tidak menjelaskan dengan jelas bahwa balasan kontak, pengelolaan email kembali, pengirim adalah pemilik - adalah setelan konfigurasi global yang dapat dikonfigurasi di bagian Setelan Email. Semua setelan Email harus berada dalam topik umum. Selain itu, banyak setelan email lainnya seperti aturan frekuensi default, setelan berhenti berlangganan tidak didokumentasikan sama sekali. Sebutkan setelan mana yang wajib atau opsional.
Dari halaman pengelolaan Pantulan, hapus semua informasi tentang Webhook dan tempatkan di topik terpisah untuk Webhook. Kemudian, kami dapat memberikan link ke topik tersebut dari sini.

Selain itu: - Topik Dasbor memiliki informasi yang tidak lengkap tentang widget yang tersedia. Informasi ini penting dan perlu ditambahkan karena membantu pengguna menganalisis dan memantau resource Mautic mereka.

Seluruh dokumentasi perlu dipelajari untuk mengidentifikasi kesenjangan. Kami perlu melakukan perubahan agar dokumen lebih mudah dipahami oleh pengguna.

Bagaimana saya berharap pengetahuan/pengalaman saya bermanfaat untuk proyek ini?

Setelah menangani berbagai masalah dalam dokumentasi Mautic, termasuk menambahkan dukungan untuk rilis Mautic 3.0 terbaru selama sebulan terakhir, saya dapat memahami struktur dokumentasi pengguna akhir dan juga mengidentifikasi kekurangan dalam dokumentasi. Saya telah menghabiskan waktu untuk meneliti dokumentasi alat otomatisasi pemasaran lainnya dan membandingkannya dengan dokumentasi pengguna akhir Mautic untuk memahami cara mengisi kesenjangan tersebut dalam dokumentasi kami. Pemahaman saya tentang bahasa HTML, alat open source, dan prosesnya adalah keuntungan tambahan. Saya saat ini sedang mengikuti kursus riset pengalaman pengguna dan dapat menerapkan prinsip-prinsipnya untuk membuat dokumentasi yang lebih berorientasi pada pengguna. Selain itu, dengan pengalaman saya dalam arsitektur informasi, saya akan dapat mengatur konten dan mengusulkan ide untuk menyelaraskan dokumentasi kami dengan sasaran pengguna. Selain itu, saya memiliki kemampuan untuk memperluas pengetahuan saya tentang domain teknis baru. Dengan pengalaman menulis teknis selama 10 tahun dan pengalaman GSOD saya sebelumnya yang berhasil menyelesaikan project untuk organisasi di domain teknis yang benar-benar baru bagi saya, saya yakin saya akan dapat memberikan kontribusi yang baik untuk dokumentasi Mautic.