Halaman ini diterjemahkan oleh Cloud Translation API.

Project Mautic

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

Ringkasan proyek

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

Project description

Kesan pertama saya saat melihat-lihat dokumentasi yang ada:

Saat ini, dokumentasinya panjang, berlebihan di banyak tempat, tidak lengkap, dan tidak rapi yang mungkin menyulitkan pengguna untuk menemukan informasi yang mereka cari.

Sebagai pengguna pemula, saya tidak dapat memahami bagaimana berbagai elemen Mautic seperti Kampanye, aset, pesan, kategori, dll. cocok untuk memenuhi kebutuhan bisnis. Saya mengusulkan memiliki topik konseptual tingkat tinggi yang menggambarkan setiap elemen Mautic dalam 2-3 baris. Topik ini nantinya dapat terhubung ke berbagai topik tugas yang terperinci untuk setiap elemen ini.

Panduan kontributor dapat diperluas hingga mencakup lebih banyak informasi 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, pedoman untuk gambar, tabel, dll.

Selain itu, ada informasi yang sangat tidak lengkap di Email, Kampanye, dan informasi lama/sudah tidak berlaku yang perlu diperbarui.

Area tempat saya ingin berkontribusi:

Saat berdiskusi tentang saluran Slack di mana pengguna berinteraksi langsung dengan komunitas Mautic, saya menyadari bahwa Kampanye dan Email merupakan elemen penting dari Mautic. Dengan menggunakan Mautibox untuk versi 3, saya menguji dokumentasi tentang Kampanye dan menemukan bahwa dokumentasi tersebut perlu banyak pembenahan. Berikut adalah beberapa masalah yang saya temukan dan proposal saya untuk masing-masing masalah:

Pengguna Mautic dapat memilih dari berbagai tindakan, keputusan, dan kondisi saat membuat kampanye. Dokumentasi untuk banyak tindakan dan keputusan tidak ada, sementara hampir tidak ada dokumentasi untuk kondisi kampanye. Kita perlu mengidentifikasi dan menambahkan informasi yang hilang ke dokumen pengguna akhir.
Kampanye bisa saja sederhana atau sangat rumit. Dokumentasi saat ini tidak memberikan banyak manfaat bagi pengguna yang membuat kampanye untuk pertama kalinya. Saya mengusulkan untuk mengidentifikasi beberapa kasus penggunaan (baik yang sederhana maupun yang 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 sebagai referensi oleh pengguna pemula sebelum mulai membuat kampanye mereka sendiri.
Informasi tersebut membutuhkan presentasi 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 agak aneh. Model ini dapat bertingkat di bagian Kondisi.

Selain Kampanye, saya juga menguji dokumentasi untuk Email terhadap UI. Berikut adalah hal-hal yang kami usulkan untuk dikerjakan:

Konten Dinamis untuk Email tersedia untuk template email kode kustom (untuk email Template dan email Segmen), tetapi saat ini, tidak ada dokumentasinya. Tambahkan detail tentang fungsi konten dinamis dan cara menyiapkannya, beserta beberapa contohnya.
Tambahkan topik terpisah untuk email Monitoring. Hal ini dapat mencakup informasi tentang cara menggunakan widget email yang tersedia di dasbor dan bagaimana widget tersebut dapat digunakan untuk melacak metrik dan aktivitas terkait email. Selain itu, pindahkan info tentang pelacakan email di sini.
Dokumentasi tidak menjelaskan bahwa balasan kontak, pengelolaan pantulan, surat adalah pemilik - merupakan setelan konfigurasi global yang dapat dikonfigurasi di bagian Setelan Email. Semua setelan Email harus berada di bawah topik umum. Selain itu, banyak setelan email lainnya seperti aturan frekuensi default, setelan berhenti berlangganan sama sekali tidak didokumentasikan. Sebutkan setelan mana yang wajib atau opsional.
Dari halaman Pengelolaan pantulan, hapus semua informasi tentang Webhook dan tempatkan di topik terpisah untuk Webhook. Selanjutnya, 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 diambil untuk mengidentifikasi kesenjangan. Kita perlu mengubah hal yang membuat dokumen lebih mudah diakses oleh pengguna.

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

Setelah mengerjakan berbagai masalah dalam dokumentasi Mautic termasuk menambahkan dukungan untuk rilis Mautic 3.0 terbaru selama sebulan terakhir, saya dapat membiasakan diri dengan struktur dokumentasi pengguna akhir dan juga mengidentifikasi kesenjangan dalam dokumentasi. Saya telah meluangkan waktu untuk meneliti dokumentasi untuk alat otomatisasi pemasaran lainnya dan membandingkannya dengan dokumentasi pengguna akhir Mautic untuk memahami cara mengisi kekurangan tersebut dalam dokumentasi kami. Pemahaman saya dalam bahasa HTML, alat {i>open source<i}, dan proses adalah keuntungan tambahan. Saat ini saya sedang mengikuti kursus penelitian pengalaman pengguna dan dapat menerapkan prinsip-prinsip untuk membuat dokumentasi yang lebih berorientasi pada pengguna. Selain itu, dengan pengalaman saya di bidang arsitektur informasi, saya akan dapat mengatur konten dan mengusulkan ide untuk menyelaraskan dokumentasi dengan tujuan pengguna. Selain itu, saya memiliki bakat untuk memperluas pengetahuan tentang domain teknis baru. Dengan pengalaman menulis teknis 10 tahun dan pengalaman GSOD sebelumnya dalam menyelesaikan proyek untuk sebuah organisasi di ranah teknis yang benar-benar baru bagi saya, saya yakin saya dapat memberikan kontribusi yang sesuai terhadap kontribusi saya pada dokumentasi Mautic.