Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan proyek
- Organisasi open source:
- WordPress
- Penulis teknis:
- dmivelli
- Nama project:
- Meningkatkan Visibilitas Artikel di Dokumentasi HelpHub WordPress
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Ringkasan Eksekutif
Popularitas WordPress terus meningkat setiap menit. Pada awal Juli 2020, WordPress 5.4 (versi terbaru yang dirilis pada 21 Maret 2020) telah diunduh hampir 51 juta kali. Bahasa yang paling umum digunakan adalah bahasa Inggris (71%), diikuti dengan bahasa Spanyol (4,7%), dan bahasa Indonesia (2,4%).
Dokumentasi teknis yang bagus adalah tulang punggung sistem bantuan apa pun. Penulis teknis berpengalaman mengolah pengetahuan menjadi konten untuk pengguna. Pengguna ingin melakukan beberapa tindakan yang bernilai bagi atau diperlukan bagi mereka pada saat itu. Penulis teknis yang baik memahami bahwa dokumentasi yang ditulis dengan baik dan akurat serta kemampuan untuk menempatkan diri mereka sebagai pengguna sangatlah penting. Namun, hal yang mungkin paling penting bagi penulis teknis, seperti kualitas editorial dan produksi, mungkin kurang penting bagi pengguna dibandingkan ketepatan waktu dan visibilitas. Apa gunanya topik bantuan yang ditulis dengan baik jika pengguna tidak dapat menemukannya?
Sejak awal diluncurkan pada tahun 2003, pertumbuhan WordPress di arena Open Source telah menarik developer, pengguna, dan kontributor. Kategori dan tag artikel asli perlu diperbarui dan dimodernisasi agar dapat mengikuti pertumbuhan dan perubahan kebutuhan komunitas WordPress.
Jika jalur pengguna ke dokumentasi yang diminta membingungkan atau terganggu, mereka akan gagal dalam penelusuran, kehilangan kepercayaan pada produk, dan mungkin akan meninggalkannya sama sekali.
Ada solusinya. Berikut adalah cara untuk meningkatkan visibilitas dan mendukung jalur pengguna ke dokumentasi yang diharapkan:
- Menentukan dan menetapkan gaya untuk judul kategori
- Evaluasi judul kategori dan pastikan judul tersebut membahas topik dengan benar (ajukan pembaruan, jika perlu)
- Tinjau artikel dan pastikan kategorisasinya sudah benar
- Tentukan subkategori untuk setiap artikel
- Pastikan tidak ada hasil penelusuran yang memandu pengguna untuk mendukung forum
- Menandai topik duplikat atau usang untuk dihapus
Komunitas WordPress telah menyelesaikan pekerjaan yang luar biasa dan berbagi dalam pencapaian selama 17 tahun terakhir. Memperbarui kategorisasi dan memastikan perjalanan pengguna akurat akan terus mendorong pertumbuhan, kesuksesan, dan loyalitas pengguna yang membuat hampir 70 juta postingan baru dan 77 juta komentar baru setiap bulan.
Pengantar
Penulis Joseph Campbell mencetuskan istilah Perjalanan Pahlawan. Dalam fiksi, ini mengacu pada konsep struktural saat protagonis melakukan perjalanan ke dunia, menghadapi dan mengatasi tantangan, serta kembali dengan berubah.
Di ranah dokumentasi teknis, pengguna juga memulai perjalanan – perjalanan yang membawa mereka ke topik bantuan dengan tujuan untuk belajar, mendapatkan jawaban, dan memecahkan masalah. Jika pengguna dapat melakukannya, semuanya akan baik-baik saja. Jika tidak dapat menemukan jawaban, pengguna akan merasa frustrasi dan kecewa.
Namun, mengapa hal ini terjadi? Hal ini bukan karena penulis mengambil jalan pintas, tidak peduli, atau tidak memiliki pengetahuan. Sering kali, penulis teknis tidak mempertimbangkan perjalanan pengguna. Penulis mungkin tenggelam dalam membuat konten yang baik, tetapi gagal mempertimbangkan cara pengguna mengakses topik tersebut. Memfokuskan pada perjalanan pengguna sangatlah penting. Kita harus mempertimbangkan apa yang ingin mereka ketahui dan bagaimana mereka ingin mendapatkannya.
Saya berbicara dengan Konsultan WordPress dan UX Designer Estela Rueda, yang memberikan beberapa informasi sejarah. Saat ini, beberapa judul tidak mendeskripsikan konten artikel dengan benar. Kategori digunakan sebagai tag dan beberapa kategori sudah usang karena dibuat 15 tahun yang lalu. Pemberian tag tidak konsisten. Hal ini menimbulkan hambatan bagi pengguna yang mencari jawaban.
Status Saat Ini
Dukungan WordPress dibagi menjadi sembilan kategori utama (Memulai, Menginstal WordPress, Penggunaan Dasar, Administrasi Dasar, Penyesuaian, Pemeliharaan, Keamanan, Topik Lanjutan, Pemecahan Masalah). Setiap kategori berisi beberapa subkategori atau subtopik yang mengarah ke artikel dengan kemungkinan lebih banyak di setiap halaman landing.
Manfaat memiliki kontributor WordPress yang antusias dan kolaboratif adalah banyak topik yang tersedia. Namun, dengan banyaknya suara dan sudut pandang, pemberian tag dan kategori menjadi tidak konsisten.
Topik ini perlu dimodernisasi untuk memastikan bahwa kategori tersebut memenuhi kebutuhan pengguna WordPress saat ini. Dengan lebih dari 200 artikel, masalah terkait tag dan kategori menjadi relevan.
Analisis Rencana
Tujuan utamanya adalah meninjau dan mengklasifikasikan ulang artikel untuk meningkatkan kemampuan penelusuran. Saya mengusulkan langkah-langkah berikut:
Bekerja sama dengan Mentor Estela Rueda untuk memperkuat proses
- Ini adalah langkah penting untuk memastikan detail dikonfirmasi dan disetujui
- Sesuai dengan saran Estela, kami akan melacak semua pembaruan yang diusulkan dalam spreadsheet (pengalaman Estela menunjukkan bahwa sebaiknya mengumpulkan, lalu mengusulkan rekomendasi)
Menentukan dan menetapkan gaya untuk judul kategori
- Saya menyarankan struktur yang seragam dan konsisten untuk kategori dalam bentuk present tense, bukan bentuk gerund (Instal vs. menginstal), karena bentuk gerund (-ing) dapat menimbulkan kesulitan bagi pengguna Bahasa Inggris sebagai Bahasa Kedua (ESL) dan -ing tidak menambah nilai bagi pengguna
- Beberapa kategori adalah subjek satu dan dua kata (seperti Pemeliharaan, Keamanan, Administrasi Dasar) dan beberapa adalah frasa kata kerja (Memulai WordPress, Menyesuaikan) – sebaiknya diskusikan untuk membuat strukturnya konsisten
- Saya telah meneliti cara organisasi lain menyiapkan bantuan online mereka dan akan mendiskusikannya dengan mentor saya untuk melihat apa yang mungkin berguna
Evaluasi judul kategori (dan usulkan pembaruan)
- Hal ini harus dapat dikenali oleh perspektif target audiens WordPress dan sesuai dengan kebutuhan mereka saat ini
- Pastikan keduanya konsisten dan mematuhi standar Panduan Gaya WordPress
- Pastikan judul menyampaikan/menjelaskan intent
- Judul harus menjelaskan tindakan prasyarat atau status pengguna/perangkat yang diperlukan
Meninjau artikel/topik
- Apakah topik secara akurat memenuhi kebutuhan pengguna dari target audiens WordPress?
- Apakah topik menetapkan konteks yang benar atau merupakan bagian dari urutan yang lebih besar?
- Apakah langkah-langkahnya membedakan berbagai aktor dalam tugas (pengguna, sistem/perangkat, siapa yang melakukan apa)?
- Apakah aktor dibedakan dengan jelas?
- Apakah langkah-langkahnya membagi proses kompleks menjadi bagian-bagian yang dapat ditindaklanjuti?
Menentukan dan memberi tag pada subkategori
- Lihat cerita pengguna dan terus tambahkan ke {i>spreadsheet<i} untuk referensi di masa mendatang
- Terus tambahkan ke daftar subkategori dan jelaskan jalurnya
Memastikan tidak ada hasil penelusuran yang menautkan pengguna ke forum dukungan
Catat topik duplikat atau yang sudah tidak berlaku untuk dihapus; pekerjaan forensik ini akan membantu menginformasikan dan menyederhanakan perjalanan pengguna
Linimasa
Hingga 16 Agustus 2020
- Lanjutkan meninjau dokumentasi WordPress
- Menjadi lebih terbiasa dengan gaya dokumentasi WordPress
- Mencari informasi tentang praktik terbaik untuk perjalanan pelanggan dalam topik bantuan
17 Agustus – 13 September
- Mengenal dan bekerja sama dengan Estela dan komunitas WordPress
- Berkolaborasi dengan Estela untuk meningkatkan kualitas langkah-langkah project dan menyarankan pencapaian untuk penyelesaian
- Membuat jadwal untuk menyertakan pencapaian dan tugas mingguan
- Tetapkan ritme untuk pemeriksaan status dengan Estela (untuk mengatasi setiap penghalang secara tepat waktu)
14 September – 30 November
- Memulai dan mengembangkan project dengan Estela/mentor
2–5 Desember
- Mengirimkan Laporan Produk Kerja Akhir
3–10 Desember
- Mengirimkan evaluasi kesuksesan project dan evaluasi pengalaman bekerja dengan mentor dan tim WordPress
Kesimpulan
WordPress adalah sistem pengelolaan konten (CMS) yang paling populer. Menurut W3techs, WordPress adalah CMS pilihan untuk 37,7% dari semua situs, sehingga WordPress memiliki pangsa pasar CMS sebesar 63,6%.
Dengan tingkat popularitas ini, dokumentasi yang akurat dan mudah diikuti adalah keharusan untuk mendapatkan hati pengguna WordPress.
Dengan mempertimbangkan perjalanan pengguna dan pertanyaan yang menginformasikan kemungkinan jalur pengguna, WordPress dapat memodernisasi kategori bantuan dan pemberian tag untuk menjawab pertanyaan dan memecahkan masalah secara efektif. Dengan demikian, WordPress akan terus menarik pelanggan yang puas selama bertahun-tahun ke depan.