Halaman ini diterjemahkan oleh Cloud Translation API.

Project Mautic

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

Ringkasan proyek

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

Project description

Kesan pertama saya saat membuka dokumentasi yang ada:

Saat ini, dokumentasinya panjang, berlebihan di banyak tempat, tidak lengkap, dan tidak teratur yang dapat menyulitkan pengguna dalam menemukan informasi yang mereka cari.

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

Panduan berkontribusi dapat diperluas untuk 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 sedikit informasi yang tidak lengkap di Email, Kampanye, dan informasi lama/sudah tidak berlaku yang perlu diperbarui.

Area tempat saya ingin berkontribusi:

Saat melakukan diskusi tentang saluran Slack di mana 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 perlu banyak perubahan. Berikut adalah 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 untuk berbagai tindakan dan keputusan tidak ada, sementara hampir tidak ada dokumentasi terkait kondisi kampanye. Kami perlu mengidentifikasi dan menambahkan informasi yang tidak ada ke dokumen pengguna akhir.
Kampanye dapat bersifat sederhana atau sangat kompleks. Dokumentasi saat ini tidak menambahkan banyak manfaat bagi pengguna yang baru pertama kali membuat kampanye. 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 acuan bagi pengguna pemula sebelum mulai membuat kampanye sendiri.
Dalam bagian ini, informasi membutuhkan presentasi yang lebih terorganisir dan teratur. Pendekatan berbasis tugas dan konsep harus diikuti untuk meningkatkan {i>usability <i}(kegunaan). Topik-topik dapat menggunakan tabel untuk menyajikan informasi tentang tindakan, keputusan, dan kondisi. Topik 'Menggunakan pemicu tanggal' terasa agak tidak masuk akal. Model ini dapat disusun bertingkat di bagian Kondisi.

Selain Kampanye, saya juga menguji dokumentasi untuk Email terhadap UI. Berikut beberapa hal yang dapat kami usulkan:

Konten Dinamis untuk Email tersedia untuk template email kode khusus (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 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 Setelan Email. Semua setelan Email seharusnya berada di bawah topik umum. Selain itu, banyak setelan email lainnya seperti aturan frekuensi default dan 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. 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 sumber daya Mautic mereka.

Seluruh dokumentasi perlu diambil untuk mengidentifikasi kesenjangan. Kami perlu mengubahnya agar dokumen lebih mudah diakses oleh pengguna.

Bagaimana saya mengharapkan pengetahuan/pengalaman saya 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 menghabiskan waktu untuk meneliti dokumentasi untuk alat otomatisasi pemasaran lainnya dan membandingkannya dengan dokumentasi pengguna akhir Mautic untuk memahami bagaimana kami dapat 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 materi penelitian pengalaman pengguna dan dapat menerapkan prinsip-prinsip tersebut 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 kami dengan tujuan pengguna. Selain itu, saya memiliki bakat untuk memperluas pengetahuan saya tentang domain teknis baru. Dengan pengalaman menulis teknis selama 10 tahun dan pengalaman GSOD saya sebelumnya dalam menyelesaikan proyek untuk sebuah organisasi di bidang teknis yang benar-benar baru bagi saya, saya yakin saya dapat berlaku adil terhadap kontribusi saya untuk dokumentasi Mautic.